deploy: 2da30fa

punch-mission · Jun 25, 2024 · 4375fc4 · 4375fc4
1 parent 82bdf67
commit 4375fc4
Show file tree

Hide file tree

Showing 29 changed files with 860 additions and 1,410 deletions.
diff --git a/_sources/autoapi/solpolpy/core/index.rst.txt b/_sources/autoapi/solpolpy/core/index.rst.txt
@@ -9,31 +9,11 @@ solpolpy.core
 
 
 
-Attributes
-----------
-
-.. autoapisummary::
-
-   solpolpy.core.VALID_KINDS
-   solpolpy.core.transform_graph
-
-
-Exceptions
-----------
-
-.. autoapisummary::
-
-   solpolpy.core.UnsupportedTransformationError
-
-
 Functions
 ---------
 
 .. autoapisummary::
 
-   solpolpy.core.radial_north
-   solpolpy.core.load_data
-   solpolpy.core.npol_to_mzp
    solpolpy.core.resolve
    solpolpy.core.determine_input_kind
    solpolpy.core.get_transform_path
@@ -50,58 +30,6 @@ Functions
 Module Contents
 ---------------
 
-.. py:function:: radial_north(shape)
-
-   An alpha array oriented west
-
-   :param shape: how big the array should be
-   :type shape: tuple[int, int]
-
-   :returns: alpha array used in calculations
-   :rtype: np.ndarray
-
-   .. rubric:: Notes
-
-   - assumes solar north is up
-   - assumes polarizer 0 is along solar north axis
-   - creates radial polarization map
-   - angles increase in counterclockwise direction
-
-
-.. py:data:: VALID_KINDS
-
-.. py:exception:: UnsupportedTransformationError
-
-   Bases: :py:obj:`Exception`
-
-
-   Common base class for all non-exit exceptions.
-
-
-.. py:data:: transform_graph
-
-.. py:function:: load_data(path_list: List[str], mask: Optional[numpy.ndarray] = None, use_instrument_mask: bool = False) -> ndcube.NDCollection
-
-   Basic loading function. See `load_with_occulter_mask`.
-   :param path_list: list of paths to FITS files to be loaded
-   :type path_list: List[str]
-   :param mask: An optional mask to couple with images. Overrides any mask computed when use_instrument_mask=True.
-   :type mask: Optional[np.ndarray]
-   :param use_instrument_mask: If true, loads an instrument mask for common instruments defined in `get_instrument_mask`.
-   :type use_instrument_mask: bool
-
-   :returns: The data are loaded as NDCollection object with WCS and header information available.
-             The keys are labeled as 'angle_1', 'angle_2, 'angle_3', ...
-   :rtype: NDCollection
-
-
-.. py:function:: npol_to_mzp(input_collection)
-
-   .. rubric:: Notes
-
-   Equation 44 in DeForest et al. 2022.
-
-
 .. py:function:: resolve(input_data: Union[List[str], ndcube.NDCollection], out_system: str, imax_effect: bool = False) -> ndcube.NDCollection
 
    Apply - apply a polarization transformation to a set of input

diff --git a/_sources/autoapi/solpolpy/graph/index.rst.txt b/_sources/autoapi/solpolpy/graph/index.rst.txt
@@ -17,120 +17,8 @@ Attributes
    solpolpy.graph.transform_graph
 
 
-Functions
----------
-
-.. autoapisummary::
-
-   solpolpy.graph.bp3_to_bthp
-   solpolpy.graph.bp3_to_mzp
-   solpolpy.graph.bpb_to_btbr
-   solpolpy.graph.bpb_to_mzp
-   solpolpy.graph.btbr_to_bpb
-   solpolpy.graph.btbr_to_mzp
-   solpolpy.graph.btbr_to_npol
-   solpolpy.graph.fourpol_to_stokes
-   solpolpy.graph.mzp_to_bp3
-   solpolpy.graph.mzp_to_bpb
-   solpolpy.graph.mzp_to_stokes
-   solpolpy.graph.npol_to_mzp
-   solpolpy.graph.stokes_to_mzp
-
-
 Module Contents
 ---------------
 
-.. py:function:: bp3_to_bthp(input_collection)
-
-   .. rubric:: Notes
-
-   Equations 9, 15, 16 in DeForest et al. 2022.
-
-
-.. py:function:: bp3_to_mzp(input_collection)
-
-   .. rubric:: Notes
-
-   Equation 11 in DeForest et al. 2022.
-
-
-.. py:function:: bpb_to_btbr(input_collection)
-
-   .. rubric:: Notes
-
-   Equation 1 and 2 in DeForest et al. 2022.
-
-
-.. py:function:: bpb_to_mzp(input_collection)
-
-   .. rubric:: Notes
-
-   Equation 4 in DeForest et al. 2022.
-
-
-.. py:function:: btbr_to_bpb(input_collection)
-
-   .. rubric:: Notes
-
-   Equation in Table 1 in DeForest et al. 2022.
-
-
-.. py:function:: btbr_to_mzp(input_collection)
-
-   .. rubric:: Notes
-
-   Equation 3 in DeForest et al. 2022.
-
-
-.. py:function:: btbr_to_npol(input_collection, angles)
-
-   .. rubric:: Notes
-
-   Equation 3 in DeForest et al. 2022.
-   angles: list of input angles in degree
-
-
-.. py:function:: fourpol_to_stokes(input_collection)
-
-   .. rubric:: Notes
-
-   Table 1 in DeForest et al. 2022.
-
-
-.. py:function:: mzp_to_bp3(input_collection)
-
-   .. rubric:: Notes
-
-   Equation 7, 9 and 10 in DeForest et al. 2022.
-
-
-.. py:function:: mzp_to_bpb(input_collection)
-
-   .. rubric:: Notes
-
-   Equation 7 and 9 in DeForest et al. 2022.
-
-
-.. py:function:: mzp_to_stokes(input_collection)
-
-   .. rubric:: Notes
-
-   Equation 9, 12 and 13 in DeForest et al. 2022.
-
-
-.. py:function:: npol_to_mzp(input_collection)
-
-   .. rubric:: Notes
-
-   Equation 44 in DeForest et al. 2022.
-
-
-.. py:function:: stokes_to_mzp(input_collection)
-
-   .. rubric:: Notes
-
-   Equation 11 in DeForest et al. 2022. with alpha = np.pi/2
-
-
 .. py:data:: transform_graph
 
diff --git a/_sources/autoapi/solpolpy/instruments/index.rst.txt b/_sources/autoapi/solpolpy/instruments/index.rst.txt
@@ -9,15 +9,6 @@ solpolpy.instruments
 
 
 
-Exceptions
-----------
-
-.. autoapisummary::
-
-   solpolpy.instruments.TooFewFilesError
-   solpolpy.instruments.UnsupportedInstrumentError
-
-
 Functions
 ---------
 
@@ -31,22 +22,6 @@ Functions
 Module Contents
 ---------------
 
-.. py:exception:: TooFewFilesError
-
-   Bases: :py:obj:`Exception`
-
-
-   Common base class for all non-exit exceptions.
-
-
-.. py:exception:: UnsupportedInstrumentError
-
-   Bases: :py:obj:`Exception`
-
-
-   Common base class for all non-exit exceptions.
-
-
 .. py:function:: load_data(path_list: List[str], mask: Optional[numpy.ndarray] = None, use_instrument_mask: bool = False) -> ndcube.NDCollection
 
    Basic loading function. See `load_with_occulter_mask`.

diff --git a/_static/scripts/pydata-sphinx-theme.js b/_static/scripts/pydata-sphinx-theme.js
diff --git a/_static/scripts/pydata-sphinx-theme.js.map b/_static/scripts/pydata-sphinx-theme.js.map
diff --git a/_static/styles/pydata-sphinx-theme.css b/_static/styles/pydata-sphinx-theme.css
diff --git a/_static/styles/pydata-sphinx-theme.css.map b/_static/styles/pydata-sphinx-theme.css.map
diff --git a/_static/webpack-macros.html b/_static/webpack-macros.html
@@ -4,28 +4,28 @@
 -->
 {# Load FontAwesome icons #}
 {% macro head_pre_icons() %}
-  <link href="{{ pathto('_static/vendor/fontawesome/6.5.2/css/all.min.css', 1) }}?digest=3ee479438cf8b5e0d341" rel="stylesheet" />
+  <link href="{{ pathto('_static/vendor/fontawesome/6.5.2/css/all.min.css', 1) }}?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
   <link rel="preload" as="font" type="font/woff2" crossorigin href="{{ pathto('_static/vendor/fontawesome/6.5.2/webfonts/fa-solid-900.woff2', 1) }}" />
 <link rel="preload" as="font" type="font/woff2" crossorigin href="{{ pathto('_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2', 1) }}" />
 <link rel="preload" as="font" type="font/woff2" crossorigin href="{{ pathto('_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2', 1) }}" />
 {% endmacro %}
 
 {% macro head_pre_assets() %}
   <!-- Loaded before other Sphinx assets -->
-  <link href="{{ pathto('_static/styles/theme.css', 1) }}?digest=3ee479438cf8b5e0d341" rel="stylesheet" />
-<link href="{{ pathto('_static/styles/bootstrap.css', 1) }}?digest=3ee479438cf8b5e0d341" rel="stylesheet" />
-<link href="{{ pathto('_static/styles/pydata-sphinx-theme.css', 1) }}?digest=3ee479438cf8b5e0d341" rel="stylesheet" />
+  <link href="{{ pathto('_static/styles/theme.css', 1) }}?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
+<link href="{{ pathto('_static/styles/bootstrap.css', 1) }}?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
+<link href="{{ pathto('_static/styles/pydata-sphinx-theme.css', 1) }}?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
 {% endmacro %}
 
 {% macro head_js_preload() %}
   <!-- Pre-loaded scripts that we'll load fully later -->
-  <link rel="preload" as="script" href="{{ pathto('_static/scripts/bootstrap.js', 1) }}?digest=3ee479438cf8b5e0d341" />
-<link rel="preload" as="script" href="{{ pathto('_static/scripts/pydata-sphinx-theme.js', 1) }}?digest=3ee479438cf8b5e0d341" />
-  <script src="{{ pathto('_static/vendor/fontawesome/6.5.2/js/all.min.js', 1) }}?digest=3ee479438cf8b5e0d341"></script>
+  <link rel="preload" as="script" href="{{ pathto('_static/scripts/bootstrap.js', 1) }}?digest=dfe6caa3a7d634c4db9b" />
+<link rel="preload" as="script" href="{{ pathto('_static/scripts/pydata-sphinx-theme.js', 1) }}?digest=dfe6caa3a7d634c4db9b" />
+  <script src="{{ pathto('_static/vendor/fontawesome/6.5.2/js/all.min.js', 1) }}?digest=dfe6caa3a7d634c4db9b"></script>
 {% endmacro %}
 
 {% macro body_post() %}
   <!-- Scripts loaded after <body> so the DOM is not blocked -->
-  <script src="{{ pathto('_static/scripts/bootstrap.js', 1) }}?digest=3ee479438cf8b5e0d341"></script>
-<script src="{{ pathto('_static/scripts/pydata-sphinx-theme.js', 1) }}?digest=3ee479438cf8b5e0d341"></script>
+  <script src="{{ pathto('_static/scripts/bootstrap.js', 1) }}?digest=dfe6caa3a7d634c4db9b"></script>
+<script src="{{ pathto('_static/scripts/pydata-sphinx-theme.js', 1) }}?digest=dfe6caa3a7d634c4db9b"></script>
 {% endmacro %}