Merge branch 'document-correction-table' into 'master'

Document usage of correction table in higher level functions Closes #72 See merge request LMSAL_HUB/aia_hub/aiapy!75
LM-SAL · Jul 17, 2020 · 67e5667 · 67e5667
2 parents ef98596 + bcb532d
commit 67e5667
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 12 deletions.
diff --git a/aiapy/calibrate/prep.py b/aiapy/calibrate/prep.py
@@ -94,7 +94,8 @@ def correct_degradation(smap, **kwargs):
 
     This function applies a time-dependent correction to an AIA observation by
     dividing the observed intensity by the correction factor calculated by
-    `degradation`.
+    `degradation`. Any keyword arguments that can be passed to `degradation`
+    can also be passed in here.
 
     Parameters
     ----------
@@ -132,16 +133,24 @@ def degradation(channel: u.angstrom, obstime,
 
     All calibration terms are taken from the `aia.response` series in JSOC
     or read from the table input by the user. This function is adapted
-    directly from the `aia_bp_corrections.pro <https://hesperia.gsfc.nasa.gov/ssw/sdo/aia/idl/response/aia_bp_corrections.pro>`_
+    directly from the
+    `aia_bp_corrections.pro <https://hesperia.gsfc.nasa.gov/ssw/sdo/aia/idl/response/aia_bp_corrections.pro>`_
     routine in SolarSoft.
 
     Parameters
     ----------
     channel : `~astropy.units.Quantity`
     obstime : `~astropy.time.Time`
 
-    Additional Parameters
+    Other Parameters
     ---------------------
+    correction_table : `~astropy.table.Table` or `str`, optional
+        Table of correction parameters or path to correction table file.
+        If not specified, it will be queried from JSOC. See
+        `~aiapy.calibrate.util.get_correction_table` for more information.
+        If you are processing many images, it is recommended to
+        read the correction table once and pass it with this argument to avoid
+        multiple redundant network calls.
     calibration_version : `int`, optional
         The version of the calibration to use when calculating the degradation.
         By default, this is the most recent version available from JSOC. If you
@@ -150,6 +159,8 @@ def degradation(channel: u.angstrom, obstime,
 
     See Also
     --------
+    degradation
+    aiapy.calibrate.get_correction_table
     aiapy.response.Channel.wavelength_response
     aiapy.response.Channel.eve_correction
     """

diff --git a/aiapy/response/channel.py b/aiapy/response/channel.py
@@ -268,7 +268,7 @@ def eve_correction(self, obstime, **kwargs) -> u.dimensionless_unscaled:
         ----------
         obstime : `~astropy.time.Time`
 
-        Additional Parameters
+        Other Parameters
         ---------------------
         calibration_version : `int`, optional
             The version of the calibration to use when calculating the

diff --git a/docs/code_ref/aiapy.rst b/docs/code_ref/aiapy.rst
diff --git a/docs/code_ref/aiapy_util.rst b/docs/code_ref/aiapy_util.rst
@@ -2,3 +2,5 @@ aiapy util
 ==========
 
 .. automodapi:: aiapy.util
+    :skip: AiapyWarning, AiapyUserWarning
+    :no-inheritance-diagram:
diff --git a/docs/code_ref/index.rst b/docs/code_ref/index.rst
@@ -4,7 +4,6 @@ API Reference
 .. toctree::
    :maxdepth: 1
 
-   aiapy
    aiapy_calibrate
    aiapy_psf
    aiapy_response