Skip to content

Commit

Permalink
Deploy docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@javierggt
javierggt committed Sep 18, 2023
1 parent 4f4772e commit e33da65
Show file tree
Hide file tree
Showing 37 changed files with 5,902 additions and 14,491 deletions.
120 changes: 75 additions & 45 deletions docs/_modules/chandra_aca/aca_image.html
View file

Large diffs are not rendered by default.

494 changes: 494 additions & 0 deletions docs/_modules/chandra_aca/centroid_resid.html
View file

Large diffs are not rendered by default.

434 changes: 434 additions & 0 deletions docs/_modules/chandra_aca/dark_model.html
View file

Large diffs are not rendered by default.

391 changes: 391 additions & 0 deletions docs/_modules/chandra_aca/drift.html
View file

Large diffs are not rendered by default.

222 changes: 152 additions & 70 deletions docs/_modules/chandra_aca/maude_decom.html
View file

Large diffs are not rendered by default.

103 changes: 68 additions & 35 deletions docs/_modules/chandra_aca/planets.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,13 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>chandra_aca.planets &#8212; chandra_aca 4.41.0 documentation</title>
<title>chandra_aca.planets &#8212; chandra_aca 4.42.0 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../../_static/bootstrap-astropy.css" />

<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
<script src="../../_static/jquery.js"></script>
<script src="../../_static/underscore.js"></script>
<script src="../../_static/doctools.js"></script>
<script src="../../_static/sphinx_highlight.js"></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" />
Expand Down Expand Up @@ -46,7 +45,7 @@
<h3>Navigation</h3>
<ul>
<li>
<a href="../../index.html">chandra_aca 4.41.0 documentation</a>
<a href="../../index.html">chandra_aca 4.42.0 documentation</a>
&#187;
</li>
<li><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
Expand Down Expand Up @@ -123,7 +122,7 @@ <h1>Source code for chandra_aca.planets</h1><div class="highlight"><pre>


<div class="viewcode-block" id="NoEphemerisError"><a class="viewcode-back" href="../../planets.html#chandra_aca.planets.NoEphemerisError">[docs]</a><span class="k">class</span> <span class="nc">NoEphemerisError</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;If there is no Chandra orbital ephemeris available&quot;&quot;&quot;</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;If there is no Chandra orbital ephemeris available&quot;&quot;&quot;</span>

<span class="k">pass</span></div>

Expand Down Expand Up @@ -171,26 +170,30 @@ <h1>Source code for chandra_aca.planets</h1><div class="highlight"><pre>
<div class="viewcode-block" id="get_planet_angular_sep"><a class="viewcode-back" href="../../planets.html#chandra_aca.planets.get_planet_angular_sep">[docs]</a><span class="k">def</span> <span class="nf">get_planet_angular_sep</span><span class="p">(</span>
<span class="n">body</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">ra</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span> <span class="n">dec</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span> <span class="n">time</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">observer_position</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;earth&quot;</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">float</span><span class="p">:</span>
<span class="sd">&quot;&quot;&quot;Get angular separation between planet ``body`` and target ``ra``, ``dec``.</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get angular separation between planet ``body`` and target ``ra``, ``dec``.</span>

<span class="sd"> Valid values for the ``observer_position`` argument are:</span>

<span class="sd"> - &#39;earth&#39; (default, approximate, fastest)</span>
<span class="sd"> - &#39;chandra&#39; (reasonably accurate fast, requires fetching ephemeris)</span>
<span class="sd"> - &#39;chandra-horizons&#39; (most accurate, slow, requires internet access)</span>

<span class="sd"> :param body: str</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> body : str</span>
<span class="sd"> Body name (lower case planet name)</span>
<span class="sd"> :param ra: float</span>
<span class="sd"> ra : float</span>
<span class="sd"> RA in degrees</span>
<span class="sd"> :param dec: float</span>
<span class="sd"> dec : float</span>
<span class="sd"> Dec in degrees</span>
<span class="sd"> :param time: CxoTime-compatible object</span>
<span class="sd"> time : CxoTime-compatible object</span>
<span class="sd"> Time or times of observation</span>
<span class="sd"> :param observer_position: str</span>
<span class="sd"> observer_position : str</span>
<span class="sd"> Observer position (&#39;earth&#39;, &#39;chandra&#39;, or &#39;chandra-horizons&#39;)</span>

<span class="sd"> :returns: angular separation (deg)</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> angular separation (deg)</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="kn">from</span> <span class="nn">agasc</span> <span class="kn">import</span> <span class="n">sphere_dist</span>

Expand Down Expand Up @@ -226,16 +229,23 @@ <h1>Source code for chandra_aca.planets</h1><div class="highlight"><pre>


<div class="viewcode-block" id="get_planet_barycentric"><a class="viewcode-back" href="../../planets.html#chandra_aca.planets.get_planet_barycentric">[docs]</a><span class="k">def</span> <span class="nf">get_planet_barycentric</span><span class="p">(</span><span class="n">body</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">time</span><span class="p">:</span> <span class="n">CxoTimeLike</span> <span class="o">=</span> <span class="kc">None</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Get barycentric position for solar system ``body`` at ``time``.</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get barycentric position for solar system ``body`` at ``time``.</span>

<span class="sd"> This uses the built-in JPL ephemeris file DE432s and jplephem.</span>

<span class="sd"> ``body`` must be one of &quot;sun&quot;, &quot;mercury&quot;, &quot;venus&quot;, &quot;earth-moon-barycenter&quot;, &quot;earth&quot;,</span>
<span class="sd"> &quot;moon&quot;, &quot;mars&quot;, &quot;jupiter&quot;, &quot;saturn&quot;, &quot;uranus&quot;, &quot;neptune&quot;, or &quot;pluto&quot;.</span>

<span class="sd"> :param body: Body name (lower case planet name)</span>
<span class="sd"> :param time: Time or times for returned position (default=NOW)</span>
<span class="sd"> :returns: barycentric position (km) as (x, y, z) or N x (x, y, z)</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> body</span>
<span class="sd"> Body name (lower case planet name)</span>
<span class="sd"> time</span>
<span class="sd"> Time or times for returned position (default=NOW)</span>

<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> barycentric position (km) as (x, y, z) or N x (x, y, z)</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">kernel</span> <span class="o">=</span> <span class="n">KERNEL</span><span class="o">.</span><span class="n">val</span>
<span class="k">if</span> <span class="n">body</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">BODY_NAME_TO_KERNEL_SPEC</span><span class="p">:</span>
Expand All @@ -256,7 +266,7 @@ <h1>Source code for chandra_aca.planets</h1><div class="highlight"><pre>
<div class="viewcode-block" id="get_planet_eci"><a class="viewcode-back" href="../../planets.html#chandra_aca.planets.get_planet_eci">[docs]</a><span class="k">def</span> <span class="nf">get_planet_eci</span><span class="p">(</span>
<span class="n">body</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">time</span><span class="p">:</span> <span class="n">CxoTimeLike</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">pos_observer</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
<span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Get ECI apparent position for solar system ``body`` at ``time``.</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get ECI apparent position for solar system ``body`` at ``time``.</span>

<span class="sd"> This uses the built-in JPL ephemeris file DE432s and jplephem. The position</span>
<span class="sd"> is computed at the supplied ``time`` minus the light-travel time from the</span>
Expand All @@ -275,10 +285,19 @@ <h1>Source code for chandra_aca.planets</h1><div class="highlight"><pre>
<span class="sd"> - Jupiter: &lt; 1 arcmin with peak around 0.5 arcmin</span>
<span class="sd"> - Saturn: &lt; 0.5 arcmin with peak around 0.3 arcmin</span>

<span class="sd"> :param body: Body name (lower case planet name)</span>
<span class="sd"> :param time: Time or times for returned position (default=NOW)</span>
<span class="sd"> :param pos_observer: Observer position (default=Earth)</span>
<span class="sd"> :returns: Earth-Centered Inertial (ECI) position (km) as (x, y, z)</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> body</span>
<span class="sd"> Body name (lower case planet name)</span>
<span class="sd"> time</span>
<span class="sd"> Time or times for returned position (default=NOW)</span>
<span class="sd"> pos_observer</span>
<span class="sd"> Observer position (default=Earth)</span>

<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> ndarray</span>
<span class="sd"> Earth-Centered Inertial (ECI) position (km) as (x, y, z)</span>
<span class="sd"> or N x (x, y, z)</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">time</span> <span class="o">=</span> <span class="n">CxoTime</span><span class="p">(</span><span class="n">time</span><span class="p">)</span>
Expand All @@ -296,7 +315,7 @@ <h1>Source code for chandra_aca.planets</h1><div class="highlight"><pre>


<div class="viewcode-block" id="get_planet_chandra"><a class="viewcode-back" href="../../planets.html#chandra_aca.planets.get_planet_chandra">[docs]</a><span class="k">def</span> <span class="nf">get_planet_chandra</span><span class="p">(</span><span class="n">body</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">time</span><span class="p">:</span> <span class="n">CxoTimeLike</span> <span class="o">=</span> <span class="kc">None</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Get position for solar system ``body`` at ``time`` relative to Chandra.</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get position for solar system ``body`` at ``time`` relative to Chandra.</span>

<span class="sd"> This uses the built-in JPL ephemeris file DE432s and jplephem, along with</span>
<span class="sd"> the CXC predictive Chandra orbital ephemeris (from the OFLS). The position</span>
Expand All @@ -312,9 +331,16 @@ <h1>Source code for chandra_aca.planets</h1><div class="highlight"><pre>
<span class="sd"> - Jupiter: &lt; 0.8 arcsec</span>
<span class="sd"> - Saturn: &lt; 0.5 arcsec</span>

<span class="sd"> :param body: Body name</span>
<span class="sd"> :param time: Time or times for returned position (default=NOW)</span>
<span class="sd"> :returns: position relative to Chandra (km) as (x, y, z) or N x (x, y, z)</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> body</span>
<span class="sd"> Body name</span>
<span class="sd"> time</span>
<span class="sd"> Time or times for returned position (default=NOW)</span>

<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> position relative to Chandra (km) as (x, y, z) or N x (x, y, z)</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="kn">from</span> <span class="nn">cheta</span> <span class="kn">import</span> <span class="n">fetch</span>

Expand Down Expand Up @@ -355,7 +381,7 @@ <h1>Source code for chandra_aca.planets</h1><div class="highlight"><pre>
<span class="n">n_times</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">10</span><span class="p">,</span>
<span class="n">timeout</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mi">10</span><span class="p">,</span>
<span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Get body position and other info as seen from Chandra using JPL Horizons.</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Get body position and other info as seen from Chandra using JPL Horizons.</span>

<span class="sd"> In addition to the planet names, the ``body`` argument can be any identifier that</span>
<span class="sd"> Horizon supports, e.g. ``sun`` or ``geo`` (Earth geocenter).</span>
Expand Down Expand Up @@ -386,15 +412,22 @@ <h1>Source code for chandra_aca.planets</h1><div class="highlight"><pre>
<span class="sd"> 2020:001:18:00:00.000 277.15181 -23.19347 34.51 2.03 -1.839 5.408 31.76</span>
<span class="sd"> 2020:002:00:00:00.000 277.21454 -23.18970 34.69 2.51 -1.839 5.408 31.76</span>

<span class="sd"> :param body: one of &#39;mercury&#39;, &#39;venus&#39;, &#39;mars&#39;, &#39;jupiter&#39;, &#39;saturn&#39;,</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> body : one of &#39;mercury&#39;, &#39;venus&#39;, &#39;mars&#39;, &#39;jupiter&#39;, &#39;saturn&#39;,</span>
<span class="sd"> &#39;uranus&#39;, &#39;neptune&#39;, or any other body that Horizons supports.</span>
<span class="sd"> :param timestart: start time (any CxoTime-compatible time)</span>
<span class="sd"> :param timestop: stop time (any CxoTime-compatible time)</span>
<span class="sd"> :param n_times: number of time samples (inclusive, default=10)</span>
<span class="sd"> :param timeout: timeout for query to Horizons (secs)</span>

<span class="sd"> :returns: Table of information</span>

<span class="sd"> timestart</span>
<span class="sd"> start time (any CxoTime-compatible time)</span>
<span class="sd"> timestop</span>
<span class="sd"> stop time (any CxoTime-compatible time)</span>
<span class="sd"> n_times</span>
<span class="sd"> number of time samples (inclusive, default=10)</span>
<span class="sd"> timeout</span>
<span class="sd"> timeout for query to Horizons (secs)</span>

<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> Table of information</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="kn">import</span> <span class="nn">requests</span>

Expand Down Expand Up @@ -516,7 +549,7 @@ <h1>Source code for chandra_aca.planets</h1><div class="highlight"><pre>
<a href="#">Back to Top</a></p>
<p>
&copy; Copyright 2015, Tom Aldcroft, Jean Connelly.<br/>
Created using <a href="http://www.sphinx-doc.org/en/stable/">Sphinx</a> 4.2.0. &nbsp;
Created using <a href="http://www.sphinx-doc.org/en/stable/">Sphinx</a> 6.1.3. &nbsp;
</p>
</footer>
</body>
Expand Down
Loading

0 comments on commit e33da65

Please sign in to comment.