Deploy docs

sot · Feb 27, 2024 · 2f473e7 · 2f473e7
1 parent 9c5a53e
commit 2f473e7
Show file tree

Hide file tree

Showing 38 changed files with 3,500 additions and 441 deletions.
diff --git a/docs/_modules/index.html b/docs/_modules/index.html
@@ -1,17 +1,16 @@
-
 <!DOCTYPE html>
 
-<html lang="en">
+<html lang="en" data-content_root="../">
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Overview: module code &#8212; mica 4.35.0 documentation</title>
-    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
-    <link rel="stylesheet" type="text/css" href="../_static/bootstrap-astropy.css" />
+    <title>Overview: module code &#8212; mica 4.35.1 documentation</title>
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
+    <link rel="stylesheet" type="text/css" href="../_static/bootstrap-astropy.css?v=f4f7060c" />
 
-    <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
-    <script src="../_static/doctools.js"></script>
-    <script src="../_static/sphinx_highlight.js"></script>
+    <script src="../_static/documentation_options.js?v=7efae4b9"></script>
+    <script src="../_static/doctools.js?v=888ff710"></script>
+    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script type="text/javascript" src="../_static/sidebar.js"></script>
     <script type="text/javascript" src="../_static/copybutton.js"></script>
     <link rel="index" title="Index" href="../genindex.html" />
@@ -45,7 +44,7 @@
     <h3>Navigation</h3>
     <ul>
       <li>
-	<a href="../index.html">mica 4.35.0 documentation</a>
+	<a href="../index.html">mica 4.35.1 documentation</a>
 	 &#187;
       </li>
 
@@ -63,12 +62,17 @@ <h1>All modules for which code is available</h1>
 <ul><li><a href="mica/archive/aca_dark/dark_cal.html">mica.archive.aca_dark.dark_cal</a></li>
 <li><a href="mica/archive/aca_hdr3.html">mica.archive.aca_hdr3</a></li>
 <li><a href="mica/archive/aca_l0.html">mica.archive.aca_l0</a></li>
+<li><a href="mica/archive/asp_l1.html">mica.archive.asp_l1</a></li>
 <li><a href="mica/archive/cda/services.html">mica.archive.cda.services</a></li>
+<li><a href="mica/archive/obsid_archive.html">mica.archive.obsid_archive</a></li>
+<li><a href="mica/archive/obspar.html">mica.archive.obspar</a></li>
 <li><a href="mica/bad_obsids.html">mica.bad_obsids</a></li>
 <li><a href="mica/starcheck/starcheck.html">mica.starcheck.starcheck</a></li>
 <li><a href="mica/stats/acq_stats.html">mica.stats.acq_stats</a></li>
 <li><a href="mica/stats/guide_stats.html">mica.stats.guide_stats</a></li>
 <li><a href="mica/utils.html">mica.utils</a></li>
+<li><a href="mica/vv/process.html">mica.vv.process</a></li>
+<li><a href="mica/vv/vv.html">mica.vv.vv</a></li>
 </ul>
 
             <div class="clearer"></div>
@@ -93,7 +97,7 @@ <h1>All modules for which code is available</h1>
     <a href="#">Back to Top</a></p>
   <p>
     &copy; Copyright 2012, Jean Connelly.<br/>
-    Created using <a href="http://www.sphinx-doc.org/en/stable/">Sphinx</a> 6.1.3. &nbsp;
+    Created using <a href="http://www.sphinx-doc.org/en/stable/">Sphinx</a> 7.2.6. &nbsp;
   </p>
 </footer>
   </body>

diff --git a/docs/_modules/mica/archive/aca_dark/dark_cal.html b/docs/_modules/mica/archive/aca_dark/dark_cal.html
@@ -1,17 +1,16 @@
-
 <!DOCTYPE html>
 
-<html lang="en">
+<html lang="en" data-content_root="../../../../">
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>mica.archive.aca_dark.dark_cal &#8212; mica 4.35.0 documentation</title>
-    <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css" />
-    <link rel="stylesheet" type="text/css" href="../../../../_static/bootstrap-astropy.css" />
+    <title>mica.archive.aca_dark.dark_cal &#8212; mica 4.35.1 documentation</title>
+    <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=fa44fd50" />
+    <link rel="stylesheet" type="text/css" href="../../../../_static/bootstrap-astropy.css?v=f4f7060c" />
 
-    <script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
-    <script src="../../../../_static/doctools.js"></script>
-    <script src="../../../../_static/sphinx_highlight.js"></script>
+    <script src="../../../../_static/documentation_options.js?v=7efae4b9"></script>
+    <script src="../../../../_static/doctools.js?v=888ff710"></script>
+    <script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script type="text/javascript" src="../../../../_static/sidebar.js"></script>
     <script type="text/javascript" src="../../../../_static/copybutton.js"></script>
     <link rel="index" title="Index" href="../../../../genindex.html" />
@@ -45,7 +44,7 @@
     <h3>Navigation</h3>
     <ul>
       <li>
-	<a href="../../../../index.html">mica 4.35.0 documentation</a>
+	<a href="../../../../index.html">mica 4.35.1 documentation</a>
 	 &#187;
       </li>
       <li><a href="../../../index.html" accesskey="U">Module code</a> &#187;</li>
@@ -90,7 +89,9 @@ <h1>Source code for mica.archive.aca_dark.dark_cal</h1><div class="highlight"><p
 <span class="n">MICA_FILES</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">file_defs</span><span class="o">.</span><span class="n">MICA_FILES</span><span class="p">)</span>
 
 
-<div class="viewcode-block" id="date_to_dark_id"><a class="viewcode-back" href="../../../../api.html#mica.archive.aca_dark.dark_cal.date_to_dark_id">[docs]</a><span class="k">def</span> <span class="nf">date_to_dark_id</span><span class="p">(</span><span class="n">date</span><span class="p">):</span>
+<div class="viewcode-block" id="date_to_dark_id">
+<a class="viewcode-back" href="../../../../api.html#mica.archive.aca_dark.dark_cal.date_to_dark_id">[docs]</a>
+<span class="k">def</span> <span class="nf">date_to_dark_id</span><span class="p">(</span><span class="n">date</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Convert ``date`` to the corresponding YYYYDOY format for a dark cal identifiers.</span>
 
@@ -108,7 +109,10 @@ <h1>Source code for mica.archive.aca_dark.dark_cal</h1><div class="highlight"><p
     <span class="k">return</span> <span class="n">result</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">shape</span><span class="p">)</span></div>
 
 
-<div class="viewcode-block" id="dark_id_to_date"><a class="viewcode-back" href="../../../../api.html#mica.archive.aca_dark.dark_cal.dark_id_to_date">[docs]</a><span class="k">def</span> <span class="nf">dark_id_to_date</span><span class="p">(</span><span class="n">dark_id</span><span class="p">):</span>
+
+<div class="viewcode-block" id="dark_id_to_date">
+<a class="viewcode-back" href="../../../../api.html#mica.archive.aca_dark.dark_cal.dark_id_to_date">[docs]</a>
+<span class="k">def</span> <span class="nf">dark_id_to_date</span><span class="p">(</span><span class="n">dark_id</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Convert ``dark_id`` (YYYYDOY) to the corresponding CxoTime &#39;date&#39; format.</span>
 
@@ -125,7 +129,10 @@ <h1>Source code for mica.archive.aca_dark.dark_cal</h1><div class="highlight"><p
     <span class="k">return</span> <span class="n">b</span><span class="o">.</span><span class="n">reshape</span><span class="p">(</span><span class="n">shape</span><span class="p">)</span></div>
 
 
-<div class="viewcode-block" id="get_dark_cal_dirs"><a class="viewcode-back" href="../../../../api.html#mica.archive.aca_dark.dark_cal.get_dark_cal_dirs">[docs]</a><span class="nd">@lru_cache</span><span class="p">()</span>
+
+<div class="viewcode-block" id="get_dark_cal_dirs">
+<a class="viewcode-back" href="../../../../api.html#mica.archive.aca_dark.dark_cal.get_dark_cal_dirs">[docs]</a>
+<span class="nd">@lru_cache</span><span class="p">()</span>
 <span class="k">def</span> <span class="nf">get_dark_cal_dirs</span><span class="p">(</span><span class="n">dark_cals_dir</span><span class="o">=</span><span class="n">MICA_FILES</span><span class="p">[</span><span class="s1">&#39;dark_cals_dir&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">abs</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Get an ordered dict of directory paths containing dark current calibration files,</span>
@@ -141,7 +148,10 @@ <h1>Source code for mica.archive.aca_dark.dark_cal</h1><div class="highlight"><p
     <span class="k">return</span> <span class="n">OrderedDict</span><span class="p">(</span><span class="nb">zip</span><span class="p">(</span><span class="n">dark_cal_ids</span><span class="p">,</span> <span class="n">dark_cal_dirs</span><span class="p">))</span></div>
 
 
-<div class="viewcode-block" id="get_dark_cal_ids"><a class="viewcode-back" href="../../../../api.html#mica.archive.aca_dark.dark_cal.get_dark_cal_ids">[docs]</a><span class="nd">@lru_cache</span><span class="p">()</span>
+
+<div class="viewcode-block" id="get_dark_cal_ids">
+<a class="viewcode-back" href="../../../../api.html#mica.archive.aca_dark.dark_cal.get_dark_cal_ids">[docs]</a>
+<span class="nd">@lru_cache</span><span class="p">()</span>
 <span class="k">def</span> <span class="nf">get_dark_cal_ids</span><span class="p">(</span><span class="n">dark_cals_dir</span><span class="o">=</span><span class="n">MICA_FILES</span><span class="p">[</span><span class="s1">&#39;dark_cals_dir&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">abs</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Get an ordered dict dates as keys and dark cal identifiers (YYYYDOY) as values.</span>
@@ -155,7 +165,10 @@ <h1>Source code for mica.archive.aca_dark.dark_cal</h1><div class="highlight"><p
     <span class="k">return</span> <span class="n">OrderedDict</span><span class="p">(</span><span class="nb">zip</span><span class="p">(</span><span class="n">dates</span><span class="p">,</span> <span class="n">dark_cal_ids</span><span class="p">))</span></div>
 
 
-<div class="viewcode-block" id="get_dark_cal_id"><a class="viewcode-back" href="../../../../api.html#mica.archive.aca_dark.dark_cal.get_dark_cal_id">[docs]</a><span class="k">def</span> <span class="nf">get_dark_cal_id</span><span class="p">(</span><span class="n">date</span><span class="p">,</span> <span class="n">select</span><span class="o">=</span><span class="s1">&#39;before&#39;</span><span class="p">,</span> <span class="n">dark_cal_ids</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
+
+<div class="viewcode-block" id="get_dark_cal_id">
+<a class="viewcode-back" href="../../../../api.html#mica.archive.aca_dark.dark_cal.get_dark_cal_id">[docs]</a>
+<span class="k">def</span> <span class="nf">get_dark_cal_id</span><span class="p">(</span><span class="n">date</span><span class="p">,</span> <span class="n">select</span><span class="o">=</span><span class="s1">&#39;before&#39;</span><span class="p">,</span> <span class="n">dark_cal_ids</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Return the dark calibration id corresponding to ``date``.</span>
 
@@ -175,6 +188,7 @@ <h1>Source code for mica.archive.aca_dark.dark_cal</h1><div class="highlight"><p
     <span class="k">return</span> <span class="n">dark_id</span></div>
 
 
+
 <span class="k">def</span> <span class="nf">_get_dark_cal_id_scalar</span><span class="p">(</span><span class="n">date</span><span class="p">,</span> <span class="n">select</span><span class="o">=</span><span class="s1">&#39;before&#39;</span><span class="p">,</span> <span class="n">dark_cal_ids</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
     <span class="k">if</span> <span class="n">dark_cal_ids</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
         <span class="n">dark_cal_ids</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">get_dark_cal_dirs</span><span class="p">()</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span>
@@ -266,7 +280,9 @@ <h1>Source code for mica.archive.aca_dark.dark_cal</h1><div class="highlight"><p
     <span class="k">return</span> <span class="n">dark</span><span class="p">,</span> <span class="n">props</span>
 
 
-<div class="viewcode-block" id="get_dark_cal_image"><a class="viewcode-back" href="../../../../api.html#mica.archive.aca_dark.dark_cal.get_dark_cal_image">[docs]</a><span class="k">def</span> <span class="nf">get_dark_cal_image</span><span class="p">(</span><span class="n">date</span><span class="p">,</span> <span class="n">select</span><span class="o">=</span><span class="s1">&#39;before&#39;</span><span class="p">,</span> <span class="n">t_ccd_ref</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">aca_image</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
+<div class="viewcode-block" id="get_dark_cal_image">
+<a class="viewcode-back" href="../../../../api.html#mica.archive.aca_dark.dark_cal.get_dark_cal_image">[docs]</a>
+<span class="k">def</span> <span class="nf">get_dark_cal_image</span><span class="p">(</span><span class="n">date</span><span class="p">,</span> <span class="n">select</span><span class="o">=</span><span class="s1">&#39;before&#39;</span><span class="p">,</span> <span class="n">t_ccd_ref</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">aca_image</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
                        <span class="n">allow_negative</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Return the dark calibration image (e-/s) nearest to ``date``.</span>
@@ -288,7 +304,10 @@ <h1>Source code for mica.archive.aca_dark.dark_cal</h1><div class="highlight"><p
     <span class="k">return</span> <span class="n">dark</span></div>
 
 
-<div class="viewcode-block" id="get_dark_cal_props"><a class="viewcode-back" href="../../../../api.html#mica.archive.aca_dark.dark_cal.get_dark_cal_props">[docs]</a><span class="k">def</span> <span class="nf">get_dark_cal_props</span><span class="p">(</span><span class="n">date</span><span class="p">,</span> <span class="n">select</span><span class="o">=</span><span class="s1">&#39;before&#39;</span><span class="p">,</span> <span class="n">include_image</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">t_ccd_ref</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+
+<div class="viewcode-block" id="get_dark_cal_props">
+<a class="viewcode-back" href="../../../../api.html#mica.archive.aca_dark.dark_cal.get_dark_cal_props">[docs]</a>
+<span class="k">def</span> <span class="nf">get_dark_cal_props</span><span class="p">(</span><span class="n">date</span><span class="p">,</span> <span class="n">select</span><span class="o">=</span><span class="s1">&#39;before&#39;</span><span class="p">,</span> <span class="n">include_image</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">t_ccd_ref</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                        <span class="n">aca_image</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">allow_negative</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Return a dark calibration properties structure for ``date``</span>
@@ -318,7 +337,10 @@ <h1>Source code for mica.archive.aca_dark.dark_cal</h1><div class="highlight"><p
     <span class="k">return</span> <span class="n">props</span></div>
 
 
-<div class="viewcode-block" id="get_dark_cal_props_table"><a class="viewcode-back" href="../../../../api.html#mica.archive.aca_dark.dark_cal.get_dark_cal_props_table">[docs]</a><span class="k">def</span> <span class="nf">get_dark_cal_props_table</span><span class="p">(</span><span class="n">start</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">stop</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">include_image</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">as_table</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
+
+<div class="viewcode-block" id="get_dark_cal_props_table">
+<a class="viewcode-back" href="../../../../api.html#mica.archive.aca_dark.dark_cal.get_dark_cal_props_table">[docs]</a>
+<span class="k">def</span> <span class="nf">get_dark_cal_props_table</span><span class="p">(</span><span class="n">start</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">stop</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">include_image</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">as_table</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Return a table of dark calibration properties between ``start`` and ``stop``.</span>
 
@@ -368,6 +390,7 @@ <h1>Source code for mica.archive.aca_dark.dark_cal</h1><div class="highlight"><p
         <span class="n">props</span> <span class="o">=</span> <span class="n">table_props</span>
 
     <span class="k">return</span> <span class="n">props</span></div>
+
 </pre></div>
 
             <div class="clearer"></div>
@@ -392,7 +415,7 @@ <h1>Source code for mica.archive.aca_dark.dark_cal</h1><div class="highlight"><p
     <a href="#">Back to Top</a></p>
   <p>
     &copy; Copyright 2012, Jean Connelly.<br/>
-    Created using <a href="http://www.sphinx-doc.org/en/stable/">Sphinx</a> 6.1.3. &nbsp;
+    Created using <a href="http://www.sphinx-doc.org/en/stable/">Sphinx</a> 7.2.6. &nbsp;
   </p>
 </footer>
   </body>