Pr and Tr unit description fixed to dimensionless

README.md

@@ -4,6 +4,8 @@
 
 GasCompressibility-py is a Python library for calculating the gas compressibility factor, $Z$, based on real gas law. It is designed with practical oil field application in mind, in which the required inputs ($T$, $P$, and $\gamma_{g}$) can be readily obtained from the surface facility.
 
+If you like this package, please consider giving a star :star: on the top right corner!
+
 ## 0. Documentation
 
 Have you ever had an experience of finding the package that piques your interest, only to give up a few moments later after finding out that it has an insane learning curve because the documentation sucks? Worry not. **The package comes with extensive documentation support.** If you have any questions or looking for tutorials, just skim through this README introduction or check out the [official documentation](https://aegis4048.github.io/GasCompressibility-py/theories.html). 

docs/_modules/piper.html

@@ -366,9 +366,9 @@ <h1>Source code for piper</h1><div class="highlight"><pre>
         <span class="bp">self</span><span class="o">.</span><span class="n">K</span> <span class="o">=</span> <span class="kc">None</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Stewart-Burkhardt-VOO parameter K, (°R/psia^0.5)&quot;&quot;&quot;</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">Tr</span> <span class="o">=</span> <span class="kc">None</span>
-<span class="w">        </span><span class="sd">&quot;&quot;&quot;pseudo-reduced temperature, Tr (°R)&quot;&quot;&quot;</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;pseudo-reduced temperature, Tr (dimensionless)&quot;&quot;&quot;</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">Pr</span> <span class="o">=</span> <span class="kc">None</span>
-<span class="w">        </span><span class="sd">&quot;&quot;&quot;pseudo-reduced pressure, Pr (psia)&quot;&quot;&quot;</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;pseudo-reduced pressure, Pr (dimensionless)&quot;&quot;&quot;</span>
 
         <span class="bp">self</span><span class="o">.</span><span class="n">ps_props</span> <span class="o">=</span> <span class="p">{</span>
             <span class="s1">&#39;Tpc&#39;</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
@@ -542,7 +542,7 @@ <h1>Source code for piper</h1><div class="highlight"><pre>
 
 <div class="viewcode-block" id="Piper.calc_Tr"><a class="viewcode-back" href="../functions/piper.Piper.calc_Tr.html#piper.Piper.calc_Tr">[docs]</a>    <span class="k">def</span> <span class="nf">calc_Tr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">T</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">sg</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">Tpc</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">H2S</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">CO2</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">N2</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">J</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">K</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">ignore_conflict</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
-<span class="sd">        Calculates pseudo-reduced temperature, Tr (°R)</span>
+<span class="sd">        Calculates pseudo-reduced temperature, Tr (dimensionless)</span>
 
 <span class="sd">        Parameters</span>
 <span class="sd">        ----------</span>
@@ -566,7 +566,7 @@ <h1>Source code for piper</h1><div class="highlight"><pre>
 <span class="sd">        Returns</span>
 <span class="sd">        -------</span>
 <span class="sd">        float</span>
-<span class="sd">            pseudo-reduced temperature, Tr (°R)</span>
+<span class="sd">            pseudo-reduced temperature, Tr (dimensionless)</span>
 
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_set_first_caller_attributes</span><span class="p">(</span><span class="n">inspect</span><span class="o">.</span><span class="n">stack</span><span class="p">()[</span><span class="mi">0</span><span class="p">][</span><span class="mi">3</span><span class="p">],</span> <span class="nb">locals</span><span class="p">())</span>
@@ -579,7 +579,7 @@ <h1>Source code for piper</h1><div class="highlight"><pre>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;pseudo-reduced pressure (psi)&quot;&quot;&quot;</span>
 <div class="viewcode-block" id="Piper.calc_Pr"><a class="viewcode-back" href="../functions/piper.Piper.calc_Pr.html#piper.Piper.calc_Pr">[docs]</a>    <span class="k">def</span> <span class="nf">calc_Pr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">P</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">sg</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">Tpc</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">Ppc</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">H2S</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">CO2</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">N2</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">J</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">K</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">ignore_conflict</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
-<span class="sd">        Calculates pseudo-reduced pressure, Pr (psia)</span>
+<span class="sd">        Calculates pseudo-reduced pressure, Pr (dimensionless)</span>
 
 <span class="sd">        Parameters</span>
 <span class="sd">        ----------</span>
@@ -603,7 +603,7 @@ <h1>Source code for piper</h1><div class="highlight"><pre>
 <span class="sd">        Returns</span>
 <span class="sd">        -------</span>
 <span class="sd">        float</span>
-<span class="sd">            pseudo-reduced pressure, Pr (psia)</span>
+<span class="sd">            pseudo-reduced pressure, Pr (dimensionless)</span>
 <span class="sd">        &quot;&quot;&quot;</span>
 
         <span class="bp">self</span><span class="o">.</span><span class="n">_set_first_caller_attributes</span><span class="p">(</span><span class="n">inspect</span><span class="o">.</span><span class="n">stack</span><span class="p">()[</span><span class="mi">0</span><span class="p">][</span><span class="mi">3</span><span class="p">],</span> <span class="nb">locals</span><span class="p">())</span>

docs/_modules/sutton.html

@@ -362,9 +362,9 @@ <h1>Source code for sutton</h1><div class="highlight"><pre>
         <span class="bp">self</span><span class="o">.</span><span class="n">Ppc_corrected</span> <span class="o">=</span> <span class="kc">None</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;corrected pseudo-critical pressure, P&#39;pc (psia)&quot;&quot;&quot;</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">Tr</span> <span class="o">=</span> <span class="kc">None</span>
-<span class="w">        </span><span class="sd">&quot;&quot;&quot;pseudo-reduced temperature, Tr (°R)&quot;&quot;&quot;</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;pseudo-reduced temperature, Tr (dimensionless)&quot;&quot;&quot;</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">Pr</span> <span class="o">=</span> <span class="kc">None</span>
-<span class="w">        </span><span class="sd">&quot;&quot;&quot;pseudo-reduced pressure, Pr (psia)&quot;&quot;&quot;</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;pseudo-reduced pressure, Pr (dimensionless)&quot;&quot;&quot;</span>
 
         <span class="bp">self</span><span class="o">.</span><span class="n">ps_props</span> <span class="o">=</span> <span class="p">{</span>
             <span class="s1">&#39;Tpc&#39;</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
@@ -551,7 +551,7 @@ <h1>Source code for sutton</h1><div class="highlight"><pre>
 
 <div class="viewcode-block" id="Sutton.calc_Tr"><a class="viewcode-back" href="../functions/sutton.Sutton.calc_Tr.html#sutton.Sutton.calc_Tr">[docs]</a>    <span class="k">def</span> <span class="nf">calc_Tr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">T</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">Tpc_corrected</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">sg</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">Tpc</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">e_correction</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">H2S</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">CO2</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">ignore_conflict</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
-<span class="sd">        Calculates pseudo-reduced temperature, Tr (°R)</span>
+<span class="sd">        Calculates pseudo-reduced temperature, Tr (dimensionless)</span>
 
 <span class="sd">        Parameters</span>
 <span class="sd">        ----------</span>
@@ -575,7 +575,7 @@ <h1>Source code for sutton</h1><div class="highlight"><pre>
 <span class="sd">        Returns</span>
 <span class="sd">        -------</span>
 <span class="sd">        float</span>
-<span class="sd">            pseudo-reduced temperature, Tr (°R)</span>
+<span class="sd">            pseudo-reduced temperature, Tr (dimensionless)</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_set_first_caller_attributes</span><span class="p">(</span><span class="n">inspect</span><span class="o">.</span><span class="n">stack</span><span class="p">()[</span><span class="mi">0</span><span class="p">][</span><span class="mi">3</span><span class="p">],</span> <span class="nb">locals</span><span class="p">())</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_initialize_T</span><span class="p">(</span><span class="n">T</span><span class="p">)</span>
@@ -587,7 +587,7 @@ <h1>Source code for sutton</h1><div class="highlight"><pre>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;pseudo-reduced pressure (psi)&quot;&quot;&quot;</span>
 <div class="viewcode-block" id="Sutton.calc_Pr"><a class="viewcode-back" href="../functions/sutton.Sutton.calc_Pr.html#sutton.Sutton.calc_Pr">[docs]</a>    <span class="k">def</span> <span class="nf">calc_Pr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">P</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">Ppc_corrected</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">sg</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">Tpc</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">Ppc</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">e_correction</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">Tpc_corrected</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">H2S</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">CO2</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">ignore_conflict</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
-<span class="sd">        Calculates pseudo-reduced pressure, Pr (psia)</span>
+<span class="sd">        Calculates pseudo-reduced pressure, Pr (dimensionless)</span>
 
 <span class="sd">        Parameters</span>
 <span class="sd">        ----------</span>
@@ -615,7 +615,7 @@ <h1>Source code for sutton</h1><div class="highlight"><pre>
 <span class="sd">        Returns</span>
 <span class="sd">        -------</span>
 <span class="sd">        float</span>
-<span class="sd">            pseudo-reduced pressure, Pr (psia)</span>
+<span class="sd">            pseudo-reduced pressure, Pr (dimensionless)</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_set_first_caller_attributes</span><span class="p">(</span><span class="n">inspect</span><span class="o">.</span><span class="n">stack</span><span class="p">()[</span><span class="mi">0</span><span class="p">][</span><span class="mi">3</span><span class="p">],</span> <span class="nb">locals</span><span class="p">())</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_initialize_P</span><span class="p">(</span><span class="n">P</span><span class="p">)</span>

docs/_modules/z_helper.html

@@ -505,9 +505,9 @@ <h1>Source code for z_helper</h1><div class="highlight"><pre>
 <span class="sd">    N2 : float</span>
 <span class="sd">        mole fraction of N2 (dimensionless). Available only when ``pmodel=&#39;piper&#39;`` (default)</span>
 <span class="sd">    Pr : float</span>
-<span class="sd">        pseudo-reduced pressure, Pr (psia)</span>
+<span class="sd">        pseudo-reduced pressure, Pr (dimensionless)</span>
 <span class="sd">    Tr : float</span>
-<span class="sd">        pseudo-reduced temperature, Tr (°R)</span>
+<span class="sd">        pseudo-reduced temperature, Tr (dimensionless)</span>
 <span class="sd">    pmodel : str</span>
 <span class="sd">        choice of a pseudo-critical model.</span>
 <span class="sd">        Check :ref:`Theories 1: Pseudo-Critical Property Models &lt;theories:1. Pseudo-Critical Property Models&gt;` for more information.</span>