ACU sunvoidance: more docs cleanup

simonsobs · Nov 6, 2023 · ef96a66 · ef96a66
1 parent f4effc8
commit ef96a66
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 7 deletions.
diff --git a/docs/agents/acu_agent.rst b/docs/agents/acu_agent.rst
@@ -105,10 +105,10 @@ determined like this:
   according to any command-line parameters passed in by the user.
 - Some parameters can be altered using the command line.
 
-The avoidance policy is defined by a few key parameters and concepts.
-
-.. automodule:: socs.agents.acu.avoidance
-
+The avoidance policy is defined by a few key parameters and concepts;
+please see the descriptions of ``sun_dist``, ``sun_time``,
+``exclusion_radius``, and more in the :mod:`socs.agents.acu.avoidance`
+module documentation.
 
 The ``exclusion_radius`` can be configured from the Agent command
 line, and also through the ``update_sun`` Task.
@@ -204,8 +204,14 @@ acquisition processes are running::
 Supporting APIs
 ---------------
 
+drivers (Scanning support)
+``````````````````````````
+
 .. automodule:: socs.agents.acu.drivers
     :members:
 
+avoidance (Sun Avoidance)
+`````````````````````````
+
 .. automodule:: socs.agents.acu.avoidance
     :members:
diff --git a/socs/agents/acu/agent.py b/socs/agents/acu/agent.py
@@ -2087,8 +2087,7 @@ def _notify_recomputed(result):
     @ocs_agent.param('avoidance_radius', type=float, default=None)
     @ocs_agent.param('shift_sun_hours', type=float, default=None)
     def update_sun(self, session, params):
-        """update_sun(reset, enable, temporary_disable, escape,
-                      avoidance_radius, shift_sun_hours)
+        """update_sun(reset, enable, temporary_disable, escape, avoidance_radius, shift_sun_hours)
 
         **Task** - Update Sun monitoring and avoidance parameters.
 

diff --git a/socs/agents/acu/avoidance.py b/socs/agents/acu/avoidance.py
@@ -87,7 +87,9 @@
 DAY = 86400
 NO_TIME = DAY * 2
 
-
+#: Default policy to apply when evaluating Sun-safety and planning
+#: trajectories.  Note the Agent code may apply different defaults,
+#: based on known platform details.
 DEFAULT_POLICY = {
     'exclusion_radius': 20,
     'min_el': 0,