diff --git a/emulsim/actors/autonomous/active_particles.py b/emulsim/actors/autonomous/active_particles.py index 6a94594..274f208 100644 --- a/emulsim/actors/autonomous/active_particles.py +++ b/emulsim/actors/autonomous/active_particles.py @@ -1,4 +1,10 @@ -""" +"""Provides an actor for simulating active particles moving according to their direction. + +.. autosummary:: + :nosignatures: + + ~ActiveParticleActor + .. codeauthor:: David Zwicker """ diff --git a/emulsim/actors/autonomous/box.py b/emulsim/actors/autonomous/box.py index 0366546..636b7cd 100644 --- a/emulsim/actors/autonomous/box.py +++ b/emulsim/actors/autonomous/box.py @@ -1,4 +1,10 @@ -""" +"""Provides an actor that confines particles inside a box. + +.. autosummary:: + :nosignatures: + + ~BoxActor + .. codeauthor:: David Zwicker """ diff --git a/emulsim/actors/autonomous/brownian_motion.py b/emulsim/actors/autonomous/brownian_motion.py index e63aa85..96b21a6 100644 --- a/emulsim/actors/autonomous/brownian_motion.py +++ b/emulsim/actors/autonomous/brownian_motion.py @@ -1,4 +1,10 @@ -""" +"""Provides an actor for simulating Brownian motion. + +.. autosummary:: + :nosignatures: + + ~BrownianMotionActor + .. codeauthor:: David Zwicker """ diff --git a/emulsim/actors/autonomous/coalescence.py b/emulsim/actors/autonomous/coalescence.py index 8abc8b4..2dc3d53 100644 --- a/emulsim/actors/autonomous/coalescence.py +++ b/emulsim/actors/autonomous/coalescence.py @@ -1,4 +1,10 @@ -""" +"""Provides an actor for simulating droplet coalescence. + +.. autosummary:: + :nosignatures: + + ~CoalescenceDropletActor + .. codeauthor:: David Zwicker """ diff --git a/emulsim/actors/autonomous/emitters.py b/emulsim/actors/autonomous/emitters.py index 33674c4..77728d2 100644 --- a/emulsim/actors/autonomous/emitters.py +++ b/emulsim/actors/autonomous/emitters.py @@ -1,4 +1,9 @@ -"""Provides a simple actor that emit mass into a field a predefined positions. +"""Provides a simple actor that emits mass into a field at predefined positions. + +.. autosummary:: + :nosignatures: + + ~EmittersActor .. codeauthor:: David Zwicker """ diff --git a/emulsim/actors/base.py b/emulsim/actors/base.py index 73b32f6..b0600ef 100644 --- a/emulsim/actors/base.py +++ b/emulsim/actors/base.py @@ -1,5 +1,11 @@ """Supplies the base class for actors. +.. autosummary:: + :nosignatures: + + ~ActorBase + ~find_actors + .. codeauthor:: David Zwicker """ diff --git a/emulsim/actors/coupling/fields.py b/emulsim/actors/coupling/fields.py index 276296e..76a9786 100644 --- a/emulsim/actors/coupling/fields.py +++ b/emulsim/actors/coupling/fields.py @@ -1,5 +1,12 @@ """Provides an actor coupling two or more fields. +.. autosummary:: + :nosignatures: + + ~FieldCouplingActor + ~FieldExchangeActor + ~FieldBoundaryExchangeActor + .. codeauthor:: David Zwicker """ diff --git a/emulsim/actors/coupling/spherical_droplet.py b/emulsim/actors/coupling/spherical_droplet.py index 41349b4..2e226f8 100644 --- a/emulsim/actors/coupling/spherical_droplet.py +++ b/emulsim/actors/coupling/spherical_droplet.py @@ -11,6 +11,7 @@ .. autosummary:: :nosignatures: + ~PointsOnSphere ~ShellSectors ~ShellCollection ~SphericalDropletActor diff --git a/emulsim/elements/base.py b/emulsim/elements/base.py index b22b67b..ab41f52 100644 --- a/emulsim/elements/base.py +++ b/emulsim/elements/base.py @@ -6,6 +6,7 @@ ArrayElementBase ArrayCollectionElementBase ObjectElementBase + DictElementBase The inheritance diagram reads diff --git a/emulsim/elements/multicomponent_droplets.py b/emulsim/elements/multicomponent_droplets.py index 934ab6e..01e604c 100644 --- a/emulsim/elements/multicomponent_droplets.py +++ b/emulsim/elements/multicomponent_droplets.py @@ -1,4 +1,10 @@ -"""Provides a simulation element representing spherical droplets. +"""Provides a simulation element representing multicomponent droplets. + +.. autosummary:: + :nosignatures: + + ~MulticomponentDroplet + ~MulticomponentDropletsElement .. codeauthor:: David Zwicker """ diff --git a/emulsim/elements/points.py b/emulsim/elements/points.py index 073dc8f..d7e2440 100644 --- a/emulsim/elements/points.py +++ b/emulsim/elements/points.py @@ -1,5 +1,11 @@ """Provides an element that represents a collection of points. +.. autosummary:: + :nosignatures: + + ~PointsElement + ~ArrowsElement + .. codeauthor:: David Zwicker """ diff --git a/emulsim/elements/spherical_droplets.py b/emulsim/elements/spherical_droplets.py index b4f7df3..dc8363d 100644 --- a/emulsim/elements/spherical_droplets.py +++ b/emulsim/elements/spherical_droplets.py @@ -1,5 +1,10 @@ """Provides a simulation element representing spherical droplets. +.. autosummary:: + :nosignatures: + + ~SphericalDropletsElement + .. codeauthor:: David Zwicker """ diff --git a/emulsim/state.py b/emulsim/state.py index 0375283..ff86ee8 100644 --- a/emulsim/state.py +++ b/emulsim/state.py @@ -1,5 +1,10 @@ """Provides a class representing the full system state of multiple elements. +.. autosummary:: + :nosignatures: + + ~State + .. inheritance-diagram:: State :parts: 1