Document syndynes.

mkelley · Dec 9, 2023 · ea0f4b9 · ea0f4b9
1 parent de277d0
commit ea0f4b9
Show file tree

Hide file tree

Showing 12 changed files with 548 additions and 287 deletions.
diff --git a/docs/sbpy/activity/dust.rst b/docs/sbpy/activity/dust.rst
diff --git a/docs/sbpy/activity/dust/dynamics.rst b/docs/sbpy/activity/dust/dynamics.rst
diff --git a/docs/sbpy/activity/dust/index.rst b/docs/sbpy/activity/dust/index.rst
diff --git a/docs/sbpy/activity/dust/syndynes.rst b/docs/sbpy/activity/dust/syndynes.rst
diff --git a/docs/sbpy/activity/index.rst b/docs/sbpy/activity/index.rst
@@ -1,16 +1,13 @@
 Activity Module (`sbpy.activity`)
 =================================
 
-Introduction
-------------
-
-`sbpy.activity` models cometary dust and gas activity.  It is separated into two main sub-modules: :doc:`dust/index` and :doc:`gas`.  The base module itself defines photometric apertures that may be useful for observations of comets.
+`sbpy.activity` models cometary dust and gas activity.  It is separated into two main sub-modules: :doc:`dust` and :doc:`gas`.  The base module itself defines photometric apertures that may be useful for observations of comets.
 
 .. toctree::
   :maxdepth: 2
   :caption: Table of Contents
 
-  dust/index
+  dust
   gas
 
 
@@ -54,3 +51,8 @@ Reference/API
 -------------
 .. automodapi:: sbpy.activity
     :no-heading:
+    :include: Aperture
+    :include: CircularAperture
+    :include: AnnularAperture
+    :include: RectangularAperture
+    :include: GaussianAperture
diff --git a/sbpy/activity/__init__.py b/sbpy/activity/__init__.py
@@ -1,5 +1,5 @@
 """
-SBPy Module for simulating cometary activity and observations.
+Cometary activity and observations.
 """
 
 from .core import *

diff --git a/sbpy/activity/dust/__init__.py b/sbpy/activity/dust/__init__.py
@@ -1,10 +1,6 @@
 # Licensed under a 3-clause BSD style license - see LICENSE.rst
 """
-sbpy Activity: dust
-===================
-
 All things comet dust related.
-
 """
 
 

diff --git a/sbpy/activity/dust/dynamics.py b/sbpy/activity/dust/dynamics.py
@@ -424,25 +424,19 @@ def from_ephem(
         )
 
 
-_dynamical_model_parameters = """
-Parameters
+class DynamicalModel(abc.ABC):
+    """Super-class for dynamical models.
+
+    Parameters
     ----------
     **kwargs
         Arguments passed on to `~scipy.integrate.solve_ivp`.  Units are seconds,
         km, and km/s, e.g., ``max_step`` is a float value in units of seconds.
         For relative and absolute tolerance keywords, ``rtol`` and ``atol``,
         6-element arrays may be used, where the first three elements are for
         position, and the last three are for velocity.
-"""
-
 
-class DynamicalModel(abc.ABC):
-    """Super-class for dynamical models.
-    
-    {}
-    """.format(
-        _dynamical_model_parameters
-    )
+    """
 
     def __init__(self, **kwargs):
         self.solver_kwargs: dict = dict(
@@ -552,12 +546,19 @@ def solve(
 
 
 class FreeExpansion(DynamicalModel):
-    """Particle motion in free space.
-    
-    {}
-    """.format(
-        _dynamical_model_parameters
-    )
+    """Equation of motion solver for particle motion in free space.
+
+
+    Parameters
+    ----------
+    **kwargs
+        Arguments passed on to `~scipy.integrate.solve_ivp`.  Units are seconds,
+        km, and km/s, e.g., ``max_step`` is a float value in units of seconds.
+        For relative and absolute tolerance keywords, ``rtol`` and ``atol``,
+        6-element arrays may be used, where the first three elements are for
+        position, and the last three are for velocity.
+
+    """
 
     @classmethod
     def dx_dt(cls, t: float, rv: np.ndarray, *args) -> np.ndarray:
@@ -580,12 +581,19 @@ def df_drv(cls, t: float, rv: np.ndarray, *args) -> np.ndarray:
 
 
 class SolarGravity(DynamicalModel):
-    """Particle orbiting the Sun.
-    
-    {}
-    """.format(
-        _dynamical_model_parameters
-    )
+    """Equation of motion solver for a particle orbiting the Sun.
+
+
+    Parameters
+    ----------
+    **kwargs
+        Arguments passed on to `~scipy.integrate.solve_ivp`.  Units are seconds,
+        km, and km/s, e.g., ``max_step`` is a float value in units of seconds.
+        For relative and absolute tolerance keywords, ``rtol`` and ``atol``,
+        6-element arrays may be used, where the first three elements are for
+        position, and the last three are for velocity.
+
+    """
 
     _GM: float = (const.G * const.M_sun).to_value("km3/s2")
 
@@ -640,7 +648,7 @@ def df_drv(cls, t: float, rv: np.ndarray, *args) -> np.ndarray:
 
 
 class SolarGravityAndRadiationPressure(DynamicalModel):
-    """Particle orbiting the Sun considering radiation force.
+    """Equation of motion solver for a particle orbiting the Sun, including radiation force.
 
 
     Dust is parameterized with ``beta``, the ratio of the force from solar
@@ -662,10 +670,16 @@ class SolarGravityAndRadiationPressure(DynamicalModel):
     Poynting-Roberston drag and general relativity are not included.
 
 
-    {}
-    """.format(
-        _dynamical_model_parameters
-    )
+    Parameters
+    ----------
+    **kwargs
+        Arguments passed on to `~scipy.integrate.solve_ivp`.  Units are seconds,
+        km, and km/s, e.g., ``max_step`` is a float value in units of seconds.
+        For relative and absolute tolerance keywords, ``rtol`` and ``atol``,
+        6-element arrays may be used, where the first three elements are for
+        position, and the last three are for velocity.
+
+    """
 
     # For quick reference
     _GM: float = (const.G * const.M_sun).to_value("km3/s2")