Skip to content

Commit

Permalink
fix some docs / type hints
Browse files Browse the repository at this point in the history
  • Loading branch information
@cchapmanbird
cchapmanbird committed Dec 18, 2024
1 parent e917408 commit 052f2cf
Show file tree
Hide file tree
Showing 12 changed files with 231 additions and 21 deletions.
Binary file modified docs/doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified docs/doctrees/user/util.doctree
View file
Binary file not shown.
8 changes: 8 additions & 0 deletions docs/html/_sources/user/util.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,14 @@ Analysis and Other Tools
:show-inheritance:
:inherited-members:

Elliptic integrals (Legendre and Carlson symmetric forms)
~~~~~~~~~~~~~~~~~~~~~~~~~

.. automodule:: few.utils.elliptic
:members:
:show-inheritance:
:inherited-members:

PN Parameter Mapping Utilities
~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down
33 changes: 28 additions & 5 deletions docs/html/genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -557,12 +557,18 @@ <h2 id="D">D</h2>
<h2 id="E">E</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="user/util.html#few.utils.utility.ELQ_to_pex">ELQ_to_pex() (in module few.utils.utility)</a>
<li><a href="user/util.html#few.utils.elliptic.EllipE">EllipE() (in module few.utils.elliptic)</a>
</li>
<li><a href="user/traj.html#few.trajectory.inspiral.EMRIInspiral">EMRIInspiral (class in few.trajectory.inspiral)</a>
<li><a href="user/util.html#few.utils.elliptic.EllipK">EllipK() (in module few.utils.elliptic)</a>
</li>
<li><a href="user/util.html#few.utils.elliptic.EllipPi">EllipPi() (in module few.utils.elliptic)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="user/util.html#few.utils.utility.ELQ_to_pex">ELQ_to_pex() (in module few.utils.utility)</a>
</li>
<li><a href="user/traj.html#few.trajectory.inspiral.EMRIInspiral">EMRIInspiral (class in few.trajectory.inspiral)</a>
</li>
<li><a href="user/traj.html#few.trajectory.inspiral.EMRIInspiral.enforce_schwarz_sep">enforce_schwarz_sep (few.trajectory.inspiral.EMRIInspiral attribute)</a>
</li>
<li><a href="user/traj.html#few.trajectory.inspiral.EMRIInspiral.equatorial">equatorial (few.trajectory.inspiral.EMRIInspiral attribute)</a>
Expand Down Expand Up @@ -642,15 +648,15 @@ <h2 id="F">F</h2>
<li><a href="user/traj.html#module-few.trajectory">module</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
few.trajectory.inspiral

<ul>
<li><a href="user/traj.html#module-few.trajectory.inspiral">module</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
few.trajectory.integrate

Expand All @@ -670,6 +676,13 @@ <h2 id="F">F</h2>

<ul>
<li><a href="user/cite.html#module-few.utils.citations">module</a>
</li>
</ul></li>
<li>
few.utils.elliptic

<ul>
<li><a href="user/util.html#module-few.utils.elliptic">module</a>
</li>
</ul></li>
<li>
Expand Down Expand Up @@ -944,6 +957,8 @@ <h2 id="M">M</h2>
<li><a href="user/util.html#module-few.utils">few.utils</a>
</li>
<li><a href="user/cite.html#module-few.utils.citations">few.utils.citations</a>
</li>
<li><a href="user/util.html#module-few.utils.elliptic">few.utils.elliptic</a>
</li>
<li><a href="user/util.html#module-few.utils.fdutils">few.utils.fdutils</a>
</li>
Expand Down Expand Up @@ -1028,10 +1043,18 @@ <h2 id="P">P</h2>
<h2 id="R">R</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="user/amp.html#few.amplitude.romannet.RomanAmplitude">RomanAmplitude (class in few.amplitude.romannet)</a>
<li><a href="user/util.html#few.utils.elliptic.RC">RC() (in module few.utils.elliptic)</a>
</li>
<li><a href="user/util.html#few.utils.elliptic.RD">RD() (in module few.utils.elliptic)</a>
</li>
<li><a href="user/util.html#few.utils.elliptic.RF">RF() (in module few.utils.elliptic)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="user/util.html#few.utils.elliptic.RJ">RJ() (in module few.utils.elliptic)</a>
</li>
<li><a href="user/amp.html#few.amplitude.romannet.RomanAmplitude">RomanAmplitude (class in few.amplitude.romannet)</a>
</li>
<li><a href="user/amp.html#few.amplitude.ampinterp2d.AmpInterp2D.run_relu_arr">run_relu_arr (few.amplitude.ampinterp2d.AmpInterp2D attribute)</a>

<ul>
Expand Down
10 changes: 10 additions & 0 deletions docs/html/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -885,6 +885,16 @@ <h2>Acknowledgments<a class="headerlink" href="#acknowledgments" title="Link to
<li class="toctree-l3"><a class="reference internal" href="user/util.html#few.utils.utility.cuda_set_device"><code class="docutils literal notranslate"><span class="pre">cuda_set_device()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="user/util.html#elliptic-integrals-legendre-and-carlson-symmetric-forms">Elliptic integrals (Legendre and Carlson symmetric forms)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="user/util.html#few.utils.elliptic.RF"><code class="docutils literal notranslate"><span class="pre">RF()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="user/util.html#few.utils.elliptic.RC"><code class="docutils literal notranslate"><span class="pre">RC()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="user/util.html#few.utils.elliptic.RJ"><code class="docutils literal notranslate"><span class="pre">RJ()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="user/util.html#few.utils.elliptic.RD"><code class="docutils literal notranslate"><span class="pre">RD()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="user/util.html#few.utils.elliptic.EllipK"><code class="docutils literal notranslate"><span class="pre">EllipK()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="user/util.html#few.utils.elliptic.EllipE"><code class="docutils literal notranslate"><span class="pre">EllipE()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="user/util.html#few.utils.elliptic.EllipPi"><code class="docutils literal notranslate"><span class="pre">EllipPi()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="user/util.html#pn-parameter-mapping-utilities">PN Parameter Mapping Utilities</a><ul>
<li class="toctree-l3"><a class="reference internal" href="user/util.html#few.utils.pn_map.Y_to_xI"><code class="docutils literal notranslate"><span class="pre">Y_to_xI()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="user/util.html#few.utils.pn_map.xI_to_Y"><code class="docutils literal notranslate"><span class="pre">xI_to_Y()</span></code></a></li>
Expand Down
Binary file modified docs/html/objects.inv
View file
Binary file not shown.
5 changes: 5 additions & 0 deletions docs/html/py-modindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,11 @@ <h1>Python Module Index</h1>
<td>&#160;&#160;&#160;
<a href="user/cite.html#module-few.utils.citations"><code class="xref">few.utils.citations</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="user/util.html#module-few.utils.elliptic"><code class="xref">few.utils.elliptic</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
Expand Down
2 changes: 1 addition & 1 deletion docs/html/searchindex.js
View file

Large diffs are not rendered by default.

Loading

0 comments on commit 052f2cf

Please sign in to comment.