Skip to content

Commit 2419ea5

Browse files
committed
documentation typo fix
1 parent e542f37 commit 2419ea5

File tree

81 files changed

+576
-628
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

81 files changed

+576
-628
lines changed

docs/build/doctrees/calc_z.doctree

-18 Bytes
Binary file not shown.
-6 Bytes
Binary file not shown.
28.8 KB
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.

docs/build/doctrees/index.doctree

-6 Bytes
Binary file not shown.

docs/build/doctrees/modules.doctree

-6 Bytes
Binary file not shown.

docs/build/doctrees/piper.doctree

-276 Bytes
Binary file not shown.
-30 Bytes
Binary file not shown.
-18 Bytes
Binary file not shown.

docs/build/doctrees/sutton.doctree

-276 Bytes
Binary file not shown.

docs/build/doctrees/theories.doctree

-6 Bytes
Binary file not shown.
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
.. _Piper.calc_J:
1+
piper.Piper.calc\_J
2+
===================
23

3-
calc_J
4-
=====================================
4+
.. currentmodule:: piper
55

6-
.. automethod:: piper.Piper.calc_J
7-
8-
.. disqus::
6+
.. automethod:: Piper.calc_J
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
.. _Piper.calc_K:
1+
piper.Piper.calc\_K
2+
===================
23

3-
calc_K
4-
=====================================
4+
.. currentmodule:: piper
55

6-
.. automethod:: piper.Piper.calc_K
7-
8-
.. disqus::
6+
.. automethod:: Piper.calc_K
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
.. _Piper.calc_Ppc:
1+
piper.Piper.calc\_Ppc
2+
=====================
23

3-
calc_Ppc
4-
=====================================
4+
.. currentmodule:: piper
55

6-
.. automethod:: piper.Piper.calc_Ppc
7-
8-
.. disqus::
6+
.. automethod:: Piper.calc_Ppc
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
.. _Piper.calc_Pr:
1+
piper.Piper.calc\_Pr
2+
====================
23

3-
calc_Pr
4-
=====================================
4+
.. currentmodule:: piper
55

6-
.. automethod:: piper.Piper.calc_Pr
7-
8-
.. disqus::
6+
.. automethod:: Piper.calc_Pr
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
.. _Piper.calc_Tpc:
1+
piper.Piper.calc\_Tpc
2+
=====================
23

3-
calc_Tpc
4-
=====================================
4+
.. currentmodule:: piper
55

6-
.. automethod:: piper.Piper.calc_Tpc
7-
8-
.. disqus::
6+
.. automethod:: Piper.calc_Tpc
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
.. _Piper.calc_Tr:
1+
piper.Piper.calc\_Tr
2+
====================
23

3-
calc_Tr
4-
=====================================
4+
.. currentmodule:: piper
55

6-
.. automethod:: piper.Piper.calc_Tr
7-
8-
.. disqus::
6+
.. automethod:: Piper.calc_Tr
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
.. _Sutton.calc_Ppc:
1+
sutton.Sutton.calc\_Ppc
2+
=======================
23

3-
calc_Ppc
4-
=====================================
4+
.. currentmodule:: sutton
55

6-
.. automethod:: sutton.Sutton.calc_Ppc
7-
8-
.. disqus::
6+
.. automethod:: Sutton.calc_Ppc
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
.. _Sutton.calc_Ppc_corrected:
1+
sutton.Sutton.calc\_Ppc\_corrected
2+
==================================
23

3-
calc_Ppc_corrected
4-
=====================================
4+
.. currentmodule:: sutton
55

6-
.. automethod:: sutton.Sutton.calc_Ppc_corrected
7-
8-
.. disqus::
6+
.. automethod:: Sutton.calc_Ppc_corrected
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
.. _Sutton.calc_Pr:
1+
sutton.Sutton.calc\_Pr
2+
======================
23

3-
calc_Pr
4-
=====================================
4+
.. currentmodule:: sutton
55

6-
.. automethod:: sutton.Sutton.calc_Pr
7-
8-
.. disqus::
6+
.. automethod:: Sutton.calc_Pr
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
.. _Sutton.calc_Tpc:
1+
sutton.Sutton.calc\_Tpc
2+
=======================
23

3-
calc_Tpc
4-
=====================================
4+
.. currentmodule:: sutton
55

6-
.. automethod:: sutton.Sutton.calc_Tpc
7-
8-
.. disqus::
6+
.. automethod:: Sutton.calc_Tpc
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
.. _Sutton.calc_Tpc_corrected:
1+
sutton.Sutton.calc\_Tpc\_corrected
2+
==================================
23

3-
calc_Tpc_corrected
4-
=====================================
4+
.. currentmodule:: sutton
55

6-
.. automethod:: sutton.Sutton.calc_Tpc_corrected
7-
8-
.. disqus::
6+
.. automethod:: Sutton.calc_Tpc_corrected
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
.. _Sutton.calc_Tr:
1+
sutton.Sutton.calc\_Tr
2+
======================
23

3-
calc_Tr
4-
=====================================
4+
.. currentmodule:: sutton
55

6-
.. automethod:: sutton.Sutton.calc_Tr
7-
8-
.. disqus::
6+
.. automethod:: Sutton.calc_Tr
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
.. _Sutton.calc_e_correction:
1+
sutton.Sutton.calc\_e\_correction
2+
=================================
23

3-
calc_e_correction
4-
=====================================
4+
.. currentmodule:: sutton
55

6-
.. automethod:: sutton.Sutton.calc_e_correction
7-
8-
.. disqus::
6+
.. automethod:: Sutton.calc_e_correction

docs/build/html/_sources/theories.rst.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -679,7 +679,7 @@ The below table summarizes the working :math:`P_r` and :math:`T_r` ranges of eac
679679
paper.
680680

681681
+-----------------+------------+------------+
682-
| Model | :math:`P_r`| :math:`T_r`|
682+
| Model | :math:`T_r`| :math:`P_r`|
683683
+=================+============+============+
684684
| DAK | [1, 3] | [0.2, 30] |
685685
+-----------------+------------+------------+

docs/build/html/calc_z.html

+14-14
Original file line numberDiff line numberDiff line change
@@ -280,22 +280,22 @@
280280
<li class="toctree-l1 current active"><a class="current reference internal" href="#">gascompressibility.calc_z</a></li>
281281
<li class="toctree-l1 has-children"><a class="reference internal" href="pseudocritical.html">Pseudo-Critical Models</a><input checked class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>
282282
<li class="toctree-l2 has-children"><a class="reference internal" href="sutton.html">gascompressibility.pseudocritical.Sutton</a><input checked class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-2"><i class="fa-solid fa-chevron-down"></i></label><ul>
283-
<li class="toctree-l3"><a class="reference internal" href="functions/sutton.Sutton.calc_Tpc.html">calc_Tpc</a></li>
284-
<li class="toctree-l3"><a class="reference internal" href="functions/sutton.Sutton.calc_Ppc.html">calc_Ppc</a></li>
285-
<li class="toctree-l3"><a class="reference internal" href="functions/sutton.Sutton.calc_e_correction.html">calc_e_correction</a></li>
286-
<li class="toctree-l3"><a class="reference internal" href="functions/sutton.Sutton.calc_Tpc_corrected.html">calc_Tpc_corrected</a></li>
287-
<li class="toctree-l3"><a class="reference internal" href="functions/sutton.Sutton.calc_Ppc_corrected.html">calc_Ppc_corrected</a></li>
288-
<li class="toctree-l3"><a class="reference internal" href="functions/sutton.Sutton.calc_Tr.html">calc_Tr</a></li>
289-
<li class="toctree-l3"><a class="reference internal" href="functions/sutton.Sutton.calc_Pr.html">calc_Pr</a></li>
283+
<li class="toctree-l3"><a class="reference internal" href="functions/sutton.Sutton.calc_Tpc.html">sutton.Sutton.calc_Tpc</a></li>
284+
<li class="toctree-l3"><a class="reference internal" href="functions/sutton.Sutton.calc_Ppc.html">sutton.Sutton.calc_Ppc</a></li>
285+
<li class="toctree-l3"><a class="reference internal" href="functions/sutton.Sutton.calc_e_correction.html">sutton.Sutton.calc_e_correction</a></li>
286+
<li class="toctree-l3"><a class="reference internal" href="functions/sutton.Sutton.calc_Tpc_corrected.html">sutton.Sutton.calc_Tpc_corrected</a></li>
287+
<li class="toctree-l3"><a class="reference internal" href="functions/sutton.Sutton.calc_Ppc_corrected.html">sutton.Sutton.calc_Ppc_corrected</a></li>
288+
<li class="toctree-l3"><a class="reference internal" href="functions/sutton.Sutton.calc_Tr.html">sutton.Sutton.calc_Tr</a></li>
289+
<li class="toctree-l3"><a class="reference internal" href="functions/sutton.Sutton.calc_Pr.html">sutton.Sutton.calc_Pr</a></li>
290290
</ul>
291291
</li>
292292
<li class="toctree-l2 has-children"><a class="reference internal" href="piper.html">gascompressibility.pseudocritical.Piper</a><input checked class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul>
293-
<li class="toctree-l3"><a class="reference internal" href="functions/piper.Piper.calc_J.html">calc_J</a></li>
294-
<li class="toctree-l3"><a class="reference internal" href="functions/piper.Piper.calc_K.html">calc_K</a></li>
295-
<li class="toctree-l3"><a class="reference internal" href="functions/piper.Piper.calc_Tpc.html">calc_Tpc</a></li>
296-
<li class="toctree-l3"><a class="reference internal" href="functions/piper.Piper.calc_Ppc.html">calc_Ppc</a></li>
297-
<li class="toctree-l3"><a class="reference internal" href="functions/piper.Piper.calc_Tr.html">calc_Tr</a></li>
298-
<li class="toctree-l3"><a class="reference internal" href="functions/piper.Piper.calc_Pr.html">calc_Pr</a></li>
293+
<li class="toctree-l3"><a class="reference internal" href="functions/piper.Piper.calc_J.html">piper.Piper.calc_J</a></li>
294+
<li class="toctree-l3"><a class="reference internal" href="functions/piper.Piper.calc_K.html">piper.Piper.calc_K</a></li>
295+
<li class="toctree-l3"><a class="reference internal" href="functions/piper.Piper.calc_Tpc.html">piper.Piper.calc_Tpc</a></li>
296+
<li class="toctree-l3"><a class="reference internal" href="functions/piper.Piper.calc_Ppc.html">piper.Piper.calc_Ppc</a></li>
297+
<li class="toctree-l3"><a class="reference internal" href="functions/piper.Piper.calc_Tr.html">piper.Piper.calc_Tr</a></li>
298+
<li class="toctree-l3"><a class="reference internal" href="functions/piper.Piper.calc_Pr.html">piper.Piper.calc_Pr</a></li>
299299
</ul>
300300
</li>
301301
</ul>
@@ -442,7 +442,7 @@ <h1>gascompressibility.calc_z<a class="headerlink" href="#gascompressibility-cal
442442
</pre></div>
443443
</div>
444444
<p><code class="docutils literal notranslate"><span class="pre">Ppc</span></code>, <code class="docutils literal notranslate"><span class="pre">e_correction</span></code>, <code class="docutils literal notranslate"><span class="pre">Tpc</span></code> aren’t default parameters defined in this function,
445-
but they can be optionally passed into Sutton’s <a class="reference internal" href="functions/sutton.Sutton.calc_Pr.html#sutton-calc-pr"><span class="std std-ref">Sutton.calc_Pr</span></a> and <a class="reference internal" href="functions/sutton.Sutton.calc_Tr.html#sutton-calc-tr"><span class="std std-ref">Sutton.calc_Tr</span></a>
445+
but they can be optionally passed into Sutton’s <span class="xref std std-ref">Sutton.calc_Pr</span> and <span class="xref std std-ref">Sutton.calc_Tr</span>
446446
methods if you already know these values (not common) and would like to compute the z-factor from these instead
447447
of using specific gravity correlation.</p>
448448
</p></li>

docs/build/html/functions/piper.Piper.calc_J.html

+21-21
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<meta charset="utf-8" />
1010
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
1111

12-
<title>calc_J &#8212; GasCompressibility-py documentation</title>
12+
<title>piper.Piper.calc_J &#8212; GasCompressibility-py documentation</title>
1313

1414

1515

@@ -43,10 +43,10 @@
4343
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
4444
<script src="../_static/doctools.js"></script>
4545
<script src="../_static/design-tabs.js"></script>
46-
<script src="../_static/disqus.js"></script>
46+
<script>DOCUMENTATION_OPTIONS.pagename = 'functions/piper.Piper.calc_J';</script>
4747
<link rel="index" title="Index" href="../genindex.html" />
4848
<link rel="search" title="Search" href="../search.html" />
49-
<link rel="next" title="calc_K" href="piper.Piper.calc_K.html" />
49+
<link rel="next" title="piper.Piper.calc_K" href="piper.Piper.calc_K.html" />
5050
<link rel="prev" title="gascompressibility.pseudocritical.Piper" href="../piper.html" />
5151
<meta name="viewport" content="width=device-width, initial-scale=1"/>
5252
<meta name="docsearch:language" content="en"/>
@@ -279,22 +279,22 @@
279279
<li class="toctree-l1"><a class="reference internal" href="../calc_z.html">gascompressibility.calc_z</a></li>
280280
<li class="toctree-l1 current active has-children"><a class="reference internal" href="../pseudocritical.html">Pseudo-Critical Models</a><input checked class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul class="current">
281281
<li class="toctree-l2 has-children"><a class="reference internal" href="../sutton.html">gascompressibility.pseudocritical.Sutton</a><input checked class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-2"><i class="fa-solid fa-chevron-down"></i></label><ul>
282-
<li class="toctree-l3"><a class="reference internal" href="sutton.Sutton.calc_Tpc.html">calc_Tpc</a></li>
283-
<li class="toctree-l3"><a class="reference internal" href="sutton.Sutton.calc_Ppc.html">calc_Ppc</a></li>
284-
<li class="toctree-l3"><a class="reference internal" href="sutton.Sutton.calc_e_correction.html">calc_e_correction</a></li>
285-
<li class="toctree-l3"><a class="reference internal" href="sutton.Sutton.calc_Tpc_corrected.html">calc_Tpc_corrected</a></li>
286-
<li class="toctree-l3"><a class="reference internal" href="sutton.Sutton.calc_Ppc_corrected.html">calc_Ppc_corrected</a></li>
287-
<li class="toctree-l3"><a class="reference internal" href="sutton.Sutton.calc_Tr.html">calc_Tr</a></li>
288-
<li class="toctree-l3"><a class="reference internal" href="sutton.Sutton.calc_Pr.html">calc_Pr</a></li>
282+
<li class="toctree-l3"><a class="reference internal" href="sutton.Sutton.calc_Tpc.html">sutton.Sutton.calc_Tpc</a></li>
283+
<li class="toctree-l3"><a class="reference internal" href="sutton.Sutton.calc_Ppc.html">sutton.Sutton.calc_Ppc</a></li>
284+
<li class="toctree-l3"><a class="reference internal" href="sutton.Sutton.calc_e_correction.html">sutton.Sutton.calc_e_correction</a></li>
285+
<li class="toctree-l3"><a class="reference internal" href="sutton.Sutton.calc_Tpc_corrected.html">sutton.Sutton.calc_Tpc_corrected</a></li>
286+
<li class="toctree-l3"><a class="reference internal" href="sutton.Sutton.calc_Ppc_corrected.html">sutton.Sutton.calc_Ppc_corrected</a></li>
287+
<li class="toctree-l3"><a class="reference internal" href="sutton.Sutton.calc_Tr.html">sutton.Sutton.calc_Tr</a></li>
288+
<li class="toctree-l3"><a class="reference internal" href="sutton.Sutton.calc_Pr.html">sutton.Sutton.calc_Pr</a></li>
289289
</ul>
290290
</li>
291291
<li class="toctree-l2 current active has-children"><a class="reference internal" href="../piper.html">gascompressibility.pseudocritical.Piper</a><input checked class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul class="current">
292-
<li class="toctree-l3 current active"><a class="current reference internal" href="#">calc_J</a></li>
293-
<li class="toctree-l3"><a class="reference internal" href="piper.Piper.calc_K.html">calc_K</a></li>
294-
<li class="toctree-l3"><a class="reference internal" href="piper.Piper.calc_Tpc.html">calc_Tpc</a></li>
295-
<li class="toctree-l3"><a class="reference internal" href="piper.Piper.calc_Ppc.html">calc_Ppc</a></li>
296-
<li class="toctree-l3"><a class="reference internal" href="piper.Piper.calc_Tr.html">calc_Tr</a></li>
297-
<li class="toctree-l3"><a class="reference internal" href="piper.Piper.calc_Pr.html">calc_Pr</a></li>
292+
<li class="toctree-l3 current active"><a class="current reference internal" href="#">piper.Piper.calc_J</a></li>
293+
<li class="toctree-l3"><a class="reference internal" href="piper.Piper.calc_K.html">piper.Piper.calc_K</a></li>
294+
<li class="toctree-l3"><a class="reference internal" href="piper.Piper.calc_Tpc.html">piper.Piper.calc_Tpc</a></li>
295+
<li class="toctree-l3"><a class="reference internal" href="piper.Piper.calc_Ppc.html">piper.Piper.calc_Ppc</a></li>
296+
<li class="toctree-l3"><a class="reference internal" href="piper.Piper.calc_Tr.html">piper.Piper.calc_Tr</a></li>
297+
<li class="toctree-l3"><a class="reference internal" href="piper.Piper.calc_Pr.html">piper.Piper.calc_Pr</a></li>
298298
</ul>
299299
</li>
300300
</ul>
@@ -347,7 +347,7 @@
347347

348348
<li class="breadcrumb-item"><a href="../piper.html" class="nav-link">gascompressibility.pseudocritical.Piper</a></li>
349349

350-
<li class="breadcrumb-item active" aria-current="page">calc_J</li>
350+
<li class="breadcrumb-item active" aria-current="page">piper.Piper.calc_J</li>
351351
</ul>
352352
</nav>
353353
</div>
@@ -364,8 +364,8 @@
364364
<div id="searchbox"></div>
365365
<article class="bd-article" role="main">
366366

367-
<section id="calc-j">
368-
<span id="piper-calc-j"></span><h1>calc_J<a class="headerlink" href="#calc-j" title="Permalink to this heading">#</a></h1>
367+
<section id="piper-piper-calc-j">
368+
<h1>piper.Piper.calc_J<a class="headerlink" href="#piper-piper-calc-j" title="Permalink to this heading">#</a></h1>
369369
<dl class="py method">
370370
<dt class="sig sig-object py" id="piper.Piper.calc_J">
371371
<span class="sig-prename descclassname"><span class="pre">Piper.</span></span><span class="sig-name descname"><span class="pre">calc_J</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sg</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">H2S</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">CO2</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">N2</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/piper.html#Piper.calc_J"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#piper.Piper.calc_J" title="Permalink to this definition">#</a></dt>
@@ -388,7 +388,7 @@
388388
</dl>
389389
</dd></dl>
390390

391-
<div data-disqus-identifier="calc_J" data-disqus-shortname="GasCompressibiltiyFactor-py" id="disqus_thread"></div></section>
391+
</section>
392392

393393

394394
</article>
@@ -415,7 +415,7 @@
415415
title="next page">
416416
<div class="prev-next-info">
417417
<p class="prev-next-subtitle">next</p>
418-
<p class="prev-next-title">calc_K</p>
418+
<p class="prev-next-title">piper.Piper.calc_K</p>
419419
</div>
420420
<i class="fa-solid fa-angle-right"></i>
421421
</a>

0 commit comments

Comments
 (0)