Deploy docs

sot · Dec 9, 2024 · 81b65a9 · 81b65a9
1 parent 8a44a24
commit 81b65a9
Show file tree

Hide file tree

Showing 19 changed files with 103 additions and 52 deletions.
diff --git a/docs/_modules/agasc/agasc.html b/docs/_modules/agasc/agasc.html
@@ -4,11 +4,11 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>agasc.agasc &#8212; Agasc 4.21.1 documentation</title>
+    <title>agasc.agasc &#8212; Agasc 4.22.0 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 src="../../_static/documentation_options.js?v=7018f786"></script>
+    <script src="../../_static/documentation_options.js?v=461fad74"></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>
@@ -44,7 +44,7 @@
     <h3>Navigation</h3>
     <ul>
       <li>
-	<a href="../../index.html">Agasc 4.21.1 documentation</a>
+	<a href="../../index.html">Agasc 4.22.0 documentation</a>
 	 &#187;
       </li>
       <li><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
@@ -97,6 +97,7 @@ <h1>Source code for agasc.agasc</h1><div class="highlight"><pre>
     <span class="s2">&quot;write_agasc&quot;</span><span class="p">,</span>
     <span class="s2">&quot;TABLE_DTYPE&quot;</span><span class="p">,</span>
     <span class="s2">&quot;TableOrder&quot;</span><span class="p">,</span>
+    <span class="s2">&quot;add_pmcorr_columns&quot;</span><span class="p">,</span>
 <span class="p">]</span>
 
 <span class="n">logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="s2">&quot;agasc&quot;</span><span class="p">)</span>
@@ -531,6 +532,8 @@ <h1>Source code for agasc.agasc</h1><div class="highlight"><pre>
         <span class="n">stars</span><span class="p">[</span><span class="s2">&quot;COLOR1&quot;</span><span class="p">][</span><span class="n">color15</span><span class="p">]</span> <span class="o">=</span> <span class="n">new_color1</span>
 
 
+<div class="viewcode-block" id="add_pmcorr_columns">
+<a class="viewcode-back" href="../../api.html#agasc.agasc.add_pmcorr_columns">[docs]</a>
 <span class="k">def</span> <span class="nf">add_pmcorr_columns</span><span class="p">(</span><span class="n">stars</span><span class="p">,</span> <span class="n">date</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Add proper-motion corrected columns RA_PMCORR and DEC_PMCORR to Table ``stars``.</span>
 
@@ -580,7 +583,8 @@ <h1>Source code for agasc.agasc</h1><div class="highlight"><pre>
             <span class="n">Column</span><span class="p">(</span><span class="n">data</span><span class="o">=</span><span class="n">ra_pmcorr</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s2">&quot;RA_PMCORR&quot;</span><span class="p">),</span>
             <span class="n">Column</span><span class="p">(</span><span class="n">data</span><span class="o">=</span><span class="n">dec_pmcorr</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s2">&quot;DEC_PMCORR&quot;</span><span class="p">),</span>
         <span class="p">]</span>
-    <span class="p">)</span>
+    <span class="p">)</span></div>
+
 
 
 <div class="viewcode-block" id="get_agasc_cone">

diff --git a/docs/_modules/agasc/paths.html b/docs/_modules/agasc/paths.html
@@ -4,11 +4,11 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>agasc.paths &#8212; Agasc 4.21.1 documentation</title>
+    <title>agasc.paths &#8212; Agasc 4.22.0 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 src="../../_static/documentation_options.js?v=7018f786"></script>
+    <script src="../../_static/documentation_options.js?v=461fad74"></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>
@@ -44,7 +44,7 @@
     <h3>Navigation</h3>
     <ul>
       <li>
-	<a href="../../index.html">Agasc 4.21.1 documentation</a>
+	<a href="../../index.html">Agasc 4.22.0 documentation</a>
 	 &#187;
       </li>
       <li><a href="../index.html" accesskey="U">Module code</a> &#187;</li>

diff --git a/docs/_modules/agasc/supplement/magnitudes/mag_estimate.html b/docs/_modules/agasc/supplement/magnitudes/mag_estimate.html
@@ -4,11 +4,11 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>agasc.supplement.magnitudes.mag_estimate &#8212; Agasc 4.21.1 documentation</title>
+    <title>agasc.supplement.magnitudes.mag_estimate &#8212; Agasc 4.22.0 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 src="../../../../_static/documentation_options.js?v=7018f786"></script>
+    <script src="../../../../_static/documentation_options.js?v=461fad74"></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>
@@ -44,7 +44,7 @@
     <h3>Navigation</h3>
     <ul>
       <li>
-	<a href="../../../../index.html">Agasc 4.21.1 documentation</a>
+	<a href="../../../../index.html">Agasc 4.22.0 documentation</a>
 	 &#187;
       </li>
       <li><a href="../../../index.html" accesskey="U">Module code</a> &#187;</li>

diff --git a/docs/_modules/agasc/supplement/magnitudes/update_mag_supplement.html b/docs/_modules/agasc/supplement/magnitudes/update_mag_supplement.html
@@ -4,11 +4,11 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>agasc.supplement.magnitudes.update_mag_supplement &#8212; Agasc 4.21.1 documentation</title>
+    <title>agasc.supplement.magnitudes.update_mag_supplement &#8212; Agasc 4.22.0 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 src="../../../../_static/documentation_options.js?v=7018f786"></script>
+    <script src="../../../../_static/documentation_options.js?v=461fad74"></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>
@@ -44,7 +44,7 @@
     <h3>Navigation</h3>
     <ul>
       <li>
-	<a href="../../../../index.html">Agasc 4.21.1 documentation</a>
+	<a href="../../../../index.html">Agasc 4.22.0 documentation</a>
 	 &#187;
       </li>
       <li><a href="../../../index.html" accesskey="U">Module code</a> &#187;</li>

diff --git a/docs/_modules/agasc/supplement/utils.html b/docs/_modules/agasc/supplement/utils.html
@@ -4,11 +4,11 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>agasc.supplement.utils &#8212; Agasc 4.21.1 documentation</title>
+    <title>agasc.supplement.utils &#8212; Agasc 4.22.0 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 src="../../../_static/documentation_options.js?v=7018f786"></script>
+    <script src="../../../_static/documentation_options.js?v=461fad74"></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>
@@ -44,7 +44,7 @@
     <h3>Navigation</h3>
     <ul>
       <li>
-	<a href="../../../index.html">Agasc 4.21.1 documentation</a>
+	<a href="../../../index.html">Agasc 4.22.0 documentation</a>
 	 &#187;
       </li>
       <li><a href="../../index.html" accesskey="U">Module code</a> &#187;</li>

diff --git a/docs/_modules/index.html b/docs/_modules/index.html
@@ -4,11 +4,11 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Overview: module code &#8212; Agasc 4.21.1 documentation</title>
+    <title>Overview: module code &#8212; Agasc 4.22.0 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 src="../_static/documentation_options.js?v=7018f786"></script>
+    <script src="../_static/documentation_options.js?v=461fad74"></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>
@@ -44,7 +44,7 @@
     <h3>Navigation</h3>
     <ul>
       <li>
-	<a href="../index.html">Agasc 4.21.1 documentation</a>
+	<a href="../index.html">Agasc 4.22.0 documentation</a>
 	 &#187;
       </li>
 

diff --git a/docs/_sources/catalog-description.rst.txt b/docs/_sources/catalog-description.rst.txt
@@ -69,21 +69,31 @@ Version 1.8 includes improved star positions and proper motions from Gaia
 DR3, as well as improved estimated magnitudes derived from Gaia DR3 photometry
 and more than 94,000 ACA observed stars. 
 
+
+Use of the AGASC 1.8 in Chandra Operations
+==========================================
+
+The Chandra Aspect Team uses an HDF5 version of the AGASC 1.8 data and
+the Python agasc package https://sot.github.io/agasc/index.html. References
+in this document to the agasc package refer to that Python code.
+Contact [email protected] if you would like to use the catalog
+directly with that Python package.
+
+
 Organization of the FITS Data Files
 ===================================
 
 The top directory includes the files::
 
     ----------------------------------------------------------------
-    readme.txt    - Introduction. ASCII
+    readme.txt    - this file
     agasc         - Directory for AGASC FITS region files.
     tables        - Directory for AGASC supporting tables.
     ----------------------------------------------------------------
 
 In the tables subdirectory are these tables::
 
     ----------------------------------------------------
-    comments.txt  - Introduction and general comments. ASCII
     regions       - Boundaries of GSC regions. FITS binary table
     lg_reg_x      - Index to large regions. FITS binary table
     sm_reg_x      - Index to small regions. FITS binary table

diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '4.21.1',
+    VERSION: '4.22.0',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/api.html b/docs/api.html
@@ -5,11 +5,11 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>API documentation &#8212; Agasc 4.21.1 documentation</title>
+    <title>API documentation &#8212; Agasc 4.22.0 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 src="_static/documentation_options.js?v=7018f786"></script>
+    <script src="_static/documentation_options.js?v=461fad74"></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>
@@ -58,7 +58,7 @@ <h3>Navigation</h3>
 	 |
       </li>
       <li>
-	<a href="index.html">Agasc 4.21.1 documentation</a>
+	<a href="index.html">Agasc 4.22.0 documentation</a>
 	 &#187;
       </li>
 
@@ -91,6 +91,30 @@ <h3>Navigation</h3>
 </ul>
 </dd></dl>
 
+<dl class="py function">
+<dt class="sig sig-object py" id="agasc.agasc.add_pmcorr_columns">
+<span class="sig-prename descclassname"><span class="pre">agasc.agasc.</span></span><span class="sig-name descname"><span class="pre">add_pmcorr_columns</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stars</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">date</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/agasc/agasc.html#add_pmcorr_columns"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#agasc.agasc.add_pmcorr_columns" title="Link to this definition">¶</a></dt>
+<dd><p>Add proper-motion corrected columns RA_PMCORR and DEC_PMCORR to Table <code class="docutils literal notranslate"><span class="pre">stars</span></code>.</p>
+<p>This computes the PM-corrected RA and Dec of all <code class="docutils literal notranslate"><span class="pre">stars</span></code> using the supplied
+<code class="docutils literal notranslate"><span class="pre">date</span></code>, which may be a scalar or an array-valued object (np.array or list).</p>
+<p>The <code class="docutils literal notranslate"><span class="pre">stars</span></code> table is updated in-place.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><dl class="simple">
+<dt><strong>stars</strong></dt><dd><p>astropy Table of stars from the AGASC</p>
+</dd>
+<dt><strong>date</strong></dt><dd><p>scalar, list, array of date(s) in DateTime-compatible format</p>
+</dd>
+</dl>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><dl class="simple">
+<dt>None</dt><dd></dd>
+</dl>
+</dd>
+</dl>
+</dd></dl>
+
 <dl class="py function">
 <dt class="sig sig-object py" id="agasc.agasc.get_agasc_cone">
 <span class="sig-prename descclassname"><span class="pre">agasc.agasc.</span></span><span class="sig-name descname"><span class="pre">get_agasc_cone</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ra</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dec</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">radius</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1.5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">date</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">agasc_file</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pm_filter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fix_color1</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_supplement</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">matlab_pm_bug</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">columns</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cache</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/agasc/agasc.html#get_agasc_cone"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#agasc.agasc.get_agasc_cone" title="Link to this definition">¶</a></dt>
@@ -725,6 +749,7 @@ <h3>Navigation</h3>
 <li><a class="reference internal" href="#">API documentation</a><ul>
 <li><a class="reference internal" href="#agasc.agasc.TABLE_DTYPE"><code class="docutils literal notranslate"><span class="pre">TABLE_DTYPE</span></code></a></li>
 <li><a class="reference internal" href="#agasc.agasc.TableOrder"><code class="docutils literal notranslate"><span class="pre">TableOrder</span></code></a></li>
+<li><a class="reference internal" href="#agasc.agasc.add_pmcorr_columns"><code class="docutils literal notranslate"><span class="pre">add_pmcorr_columns()</span></code></a></li>
 <li><a class="reference internal" href="#agasc.agasc.get_agasc_cone"><code class="docutils literal notranslate"><span class="pre">get_agasc_cone()</span></code></a></li>
 <li><a class="reference internal" href="#agasc.agasc.get_agasc_filename"><code class="docutils literal notranslate"><span class="pre">get_agasc_filename()</span></code></a></li>
 <li><a class="reference internal" href="#agasc.agasc.get_star"><code class="docutils literal notranslate"><span class="pre">get_star()</span></code></a></li>

diff --git a/docs/catalog-description-1p7.html b/docs/catalog-description-1p7.html
@@ -5,11 +5,11 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>THE AXAF Guide and Acquisition Star Catalog V1.7 &#8212; Agasc 4.21.1 documentation</title>
+    <title>THE AXAF Guide and Acquisition Star Catalog V1.7 &#8212; Agasc 4.22.0 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 src="_static/documentation_options.js?v=7018f786"></script>
+    <script src="_static/documentation_options.js?v=461fad74"></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>
@@ -58,7 +58,7 @@ <h3>Navigation</h3>
 	 |
       </li>
       <li>
-	<a href="index.html">Agasc 4.21.1 documentation</a>
+	<a href="index.html">Agasc 4.22.0 documentation</a>
 	 &#187;
       </li>