Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@christinahedges
christinahedges committed Jan 7, 2025
1 parent e3954a3 commit a35ae43
Show file tree
Hide file tree
Showing 77 changed files with 266 additions and 12,767 deletions.
Binary file modified .doctrees/Quickstart.doctree
View file
Binary file not shown.
Binary file modified .doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified .doctrees/index.doctree
View file
Binary file not shown.
43 changes: 16 additions & 27 deletions .doctrees/nbsphinx/tutorials/calculating-barycentric-time-correction.ipynb
View file

Large diffs are not rendered by default.

0 ...ting-barycentric-time-correction_22_0.png → ...ting-barycentric-time-correction_22_0.png
View file
File renamed without changes
Binary file removed .doctrees/nbsphinx/tutorials_calculating-barycentric-time-correction_22_1.png
View file
Binary file not shown.
Binary file modified .doctrees/nbsphinx/tutorials_calculating-barycentric-time-correction_34_0.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .doctrees/tutorials/calculating-barycentric-time-correction.doctree
View file
Binary file not shown.
6 changes: 3 additions & 3 deletions Contact.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="" />
<meta name="docbuild:last-update" content="06 Jan 2025"/>
<meta name="docbuild:last-update" content="07 Jan 2025"/>
</head>


Expand Down Expand Up @@ -128,7 +128,7 @@

<li class="nav-item ">
<a class="nav-link nav-internal" href="Quickstart.html">
Usage
<no title>
</a>
</li>

Expand Down Expand Up @@ -268,7 +268,7 @@

<li class="nav-item ">
<a class="nav-link nav-internal" href="Quickstart.html">
Usage
<no title>
</a>
</li>

Expand Down
6 changes: 3 additions & 3 deletions GetInvolved.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="" />
<meta name="docbuild:last-update" content="06 Jan 2025"/>
<meta name="docbuild:last-update" content="07 Jan 2025"/>
</head>


Expand Down Expand Up @@ -129,7 +129,7 @@

<li class="nav-item ">
<a class="nav-link nav-internal" href="Quickstart.html">
Usage
<no title>
</a>
</li>

Expand Down Expand Up @@ -269,7 +269,7 @@

<li class="nav-item ">
<a class="nav-link nav-internal" href="Quickstart.html">
Usage
<no title>
</a>
</li>

Expand Down
6 changes: 3 additions & 3 deletions HowtoCite.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="" />
<meta name="docbuild:last-update" content="06 Jan 2025"/>
<meta name="docbuild:last-update" content="07 Jan 2025"/>
</head>


Expand Down Expand Up @@ -129,7 +129,7 @@

<li class="nav-item ">
<a class="nav-link nav-internal" href="Quickstart.html">
Usage
<no title>
</a>
</li>

Expand Down Expand Up @@ -269,7 +269,7 @@

<li class="nav-item ">
<a class="nav-link nav-internal" href="Quickstart.html">
Usage
<no title>
</a>
</li>

Expand Down
25 changes: 17 additions & 8 deletions Quickstart.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<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>Usage &#8212; lkspacecraft</title>
<title>&lt;no title&gt; &#8212; lkspacecraft</title>



Expand Down Expand Up @@ -51,7 +51,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="" />
<meta name="docbuild:last-update" content="06 Jan 2025"/>
<meta name="docbuild:last-update" content="07 Jan 2025"/>
</head>


Expand Down Expand Up @@ -129,7 +129,7 @@

<li class="nav-item current active">
<a class="nav-link nav-internal" href="#">
Usage
<no title>
</a>
</li>

Expand Down Expand Up @@ -269,7 +269,7 @@

<li class="nav-item current active">
<a class="nav-link nav-internal" href="#">
Usage
<no title>
</a>
</li>

Expand Down Expand Up @@ -381,7 +381,7 @@
<i class="fa-solid fa-home"></i>
</a>
</li>
<li class="breadcrumb-item active" aria-current="page"><span class="ellipsis">Usage</span></li>
<li class="breadcrumb-item active" aria-current="page"><span class="ellipsis">&lt;no title&gt;</span></li>
</ul>
</nav>
</div>
Expand All @@ -406,16 +406,13 @@
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">--upgrade</span></code> flag is optional, but recommended if you already
have <code class="docutils literal notranslate"><span class="pre">lkspacecraft</span></code> installed and want to upgrade to the latest version.</p>
<section id="usage">
<h1>Usage<a class="headerlink" href="#usage" title="Link to this heading">#</a></h1>
<p>You can use <a class="reference internal" href="apidoc.html#module-lkspacecraft" title="lkspacecraft"><code class="xref py py-obj docutils literal notranslate"><span class="pre">lkspacecraft</span></code></a> to access position and velocity information of Kepler and TESS using input times</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">lkspacecraft</span> <span class="kn">import</span> <span class="n">KeplerSpacecraft</span>
<span class="n">ks</span> <span class="o">=</span> <span class="n">KeplerSpacecraft</span><span class="p">()</span>
<span class="n">t</span> <span class="o">=</span> <span class="n">Time</span><span class="p">(</span><span class="s2">&quot;2009-04-06 06:22:56.000025&quot;</span><span class="p">)</span>
<span class="n">ks</span><span class="o">.</span><span class="n">get_velocity_aberrated_positions</span><span class="p">(</span><span class="n">time</span><span class="o">=</span><span class="n">t</span><span class="p">,</span> <span class="n">ra</span><span class="o">=</span><span class="mf">290.666</span><span class="p">,</span> <span class="n">dec</span><span class="o">=</span><span class="mf">44.5</span><span class="p">)</span>
</pre></div>
</div>
</section>


</article>
Expand Down Expand Up @@ -456,6 +453,18 @@ <h1>Usage<a class="headerlink" href="#usage" title="Link to this heading">#</a><
<div id="pst-secondary-sidebar" class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">


<div class="sidebar-secondary-item">
<div
id="pst-page-navigation-heading-2"
class="page-toc tocsection onthispage">
<i class="fa-solid fa-list"></i> On this page
</div>
<nav class="bd-toc-nav page-toc" aria-labelledby="pst-page-navigation-heading-2">
<ul class="simple visible nav section-nav flex-column">
</ul>

</nav></div>

<div class="sidebar-secondary-item">
<div role="note" aria-label="source link">
<h3>This Page</h3>
Expand Down
Loading

0 comments on commit a35ae43

Please sign in to comment.