Skip to content

Commit

Permalink
Deploying to pdoc from @ 86ddb1d 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@slayoo
slayoo committed Jan 14, 2025
1 parent cc9a181 commit fdafd7c
Show file tree
Hide file tree
Showing 11 changed files with 1,823 additions and 603 deletions.
1,144 changes: 582 additions & 562 deletions PySDM/formulae.html
View file

Large diffs are not rendered by default.

36 changes: 19 additions & 17 deletions PySDM/physics.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,9 +84,10 @@ <h2>Submodules</h2>
<li><a href="physics/impl.html">impl</a></li>
<li><a href="physics/isotope_diffusivity_ratios.html">isotope_diffusivity_ratios</a></li>
<li><a href="physics/isotope_equilibrium_fractionation_factors.html">isotope_equilibrium_fractionation_factors</a></li>
<li><a href="physics/isotope_meteoric_water_line_excess.html">isotope_meteoric_water_line_excess</a></li>
<li><a href="physics/isotope_meteoric_water_line.html">isotope_meteoric_water_line</a></li>
<li><a href="physics/isotope_ratio_evolution.html">isotope_ratio_evolution</a></li>
<li><a href="physics/isotope_relaxation_timescale.html">isotope_relaxation_timescale</a></li>
<li><a href="physics/isotope_temperature_inference.html">isotope_temperature_inference</a></li>
<li><a href="physics/latent_heat.html">latent_heat</a></li>
<li><a href="physics/optical_albedo.html">optical_albedo</a></li>
<li><a href="physics/optical_depth.html">optical_depth</a></li>
Expand Down Expand Up @@ -169,25 +170,26 @@ <h1 class="modulename">
</span><span id="L-29"><a href="#L-29"><span class="linenos">29</span></a> <span class="n">hygroscopicity</span><span class="p">,</span>
</span><span id="L-30"><a href="#L-30"><span class="linenos">30</span></a> <span class="n">impl</span><span class="p">,</span>
</span><span id="L-31"><a href="#L-31"><span class="linenos">31</span></a> <span class="n">isotope_equilibrium_fractionation_factors</span><span class="p">,</span>
</span><span id="L-32"><a href="#L-32"><span class="linenos">32</span></a> <span class="n">isotope_meteoric_water_line_excess</span><span class="p">,</span>
</span><span id="L-32"><a href="#L-32"><span class="linenos">32</span></a> <span class="n">isotope_meteoric_water_line</span><span class="p">,</span>
</span><span id="L-33"><a href="#L-33"><span class="linenos">33</span></a> <span class="n">isotope_ratio_evolution</span><span class="p">,</span>
</span><span id="L-34"><a href="#L-34"><span class="linenos">34</span></a> <span class="n">isotope_diffusivity_ratios</span><span class="p">,</span>
</span><span id="L-35"><a href="#L-35"><span class="linenos">35</span></a> <span class="n">isotope_relaxation_timescale</span><span class="p">,</span>
</span><span id="L-36"><a href="#L-36"><span class="linenos">36</span></a> <span class="n">latent_heat</span><span class="p">,</span>
</span><span id="L-37"><a href="#L-37"><span class="linenos">37</span></a> <span class="n">optical_albedo</span><span class="p">,</span>
</span><span id="L-38"><a href="#L-38"><span class="linenos">38</span></a> <span class="n">optical_depth</span><span class="p">,</span>
</span><span id="L-39"><a href="#L-39"><span class="linenos">39</span></a> <span class="n">particle_advection</span><span class="p">,</span>
</span><span id="L-40"><a href="#L-40"><span class="linenos">40</span></a> <span class="n">particle_shape_and_density</span><span class="p">,</span>
</span><span id="L-41"><a href="#L-41"><span class="linenos">41</span></a> <span class="n">saturation_vapour_pressure</span><span class="p">,</span>
</span><span id="L-42"><a href="#L-42"><span class="linenos">42</span></a> <span class="n">state_variable_triplet</span><span class="p">,</span>
</span><span id="L-43"><a href="#L-43"><span class="linenos">43</span></a> <span class="n">surface_tension</span><span class="p">,</span>
</span><span id="L-44"><a href="#L-44"><span class="linenos">44</span></a> <span class="n">trivia</span><span class="p">,</span>
</span><span id="L-45"><a href="#L-45"><span class="linenos">45</span></a> <span class="n">ventilation</span><span class="p">,</span>
</span><span id="L-46"><a href="#L-46"><span class="linenos">46</span></a> <span class="n">air_dynamic_viscosity</span><span class="p">,</span>
</span><span id="L-47"><a href="#L-47"><span class="linenos">47</span></a> <span class="n">terminal_velocity</span><span class="p">,</span>
</span><span id="L-48"><a href="#L-48"><span class="linenos">48</span></a> <span class="n">bulk_phase_partitioning</span><span class="p">,</span>
</span><span id="L-49"><a href="#L-49"><span class="linenos">49</span></a><span class="p">)</span>
</span><span id="L-50"><a href="#L-50"><span class="linenos">50</span></a><span class="kn">from</span><span class="w"> </span><span class="nn">.constants</span><span class="w"> </span><span class="kn">import</span> <span class="n">convert_to</span><span class="p">,</span> <span class="n">in_unit</span><span class="p">,</span> <span class="n">si</span>
</span><span id="L-36"><a href="#L-36"><span class="linenos">36</span></a> <span class="n">isotope_temperature_inference</span><span class="p">,</span>
</span><span id="L-37"><a href="#L-37"><span class="linenos">37</span></a> <span class="n">latent_heat</span><span class="p">,</span>
</span><span id="L-38"><a href="#L-38"><span class="linenos">38</span></a> <span class="n">optical_albedo</span><span class="p">,</span>
</span><span id="L-39"><a href="#L-39"><span class="linenos">39</span></a> <span class="n">optical_depth</span><span class="p">,</span>
</span><span id="L-40"><a href="#L-40"><span class="linenos">40</span></a> <span class="n">particle_advection</span><span class="p">,</span>
</span><span id="L-41"><a href="#L-41"><span class="linenos">41</span></a> <span class="n">particle_shape_and_density</span><span class="p">,</span>
</span><span id="L-42"><a href="#L-42"><span class="linenos">42</span></a> <span class="n">saturation_vapour_pressure</span><span class="p">,</span>
</span><span id="L-43"><a href="#L-43"><span class="linenos">43</span></a> <span class="n">state_variable_triplet</span><span class="p">,</span>
</span><span id="L-44"><a href="#L-44"><span class="linenos">44</span></a> <span class="n">surface_tension</span><span class="p">,</span>
</span><span id="L-45"><a href="#L-45"><span class="linenos">45</span></a> <span class="n">trivia</span><span class="p">,</span>
</span><span id="L-46"><a href="#L-46"><span class="linenos">46</span></a> <span class="n">ventilation</span><span class="p">,</span>
</span><span id="L-47"><a href="#L-47"><span class="linenos">47</span></a> <span class="n">air_dynamic_viscosity</span><span class="p">,</span>
</span><span id="L-48"><a href="#L-48"><span class="linenos">48</span></a> <span class="n">terminal_velocity</span><span class="p">,</span>
</span><span id="L-49"><a href="#L-49"><span class="linenos">49</span></a> <span class="n">bulk_phase_partitioning</span><span class="p">,</span>
</span><span id="L-50"><a href="#L-50"><span class="linenos">50</span></a><span class="p">)</span>
</span><span id="L-51"><a href="#L-51"><span class="linenos">51</span></a><span class="kn">from</span><span class="w"> </span><span class="nn">.constants</span><span class="w"> </span><span class="kn">import</span> <span class="n">convert_to</span><span class="p">,</span> <span class="n">in_unit</span><span class="p">,</span> <span class="n">si</span>
</span></pre></div>


Expand Down
125 changes: 125 additions & 0 deletions PySDM/physics/constants_defaults.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -797,6 +797,24 @@ <h2>API Documentation</h2>
<li>
<a class="variable" href="#BOLIN_ISOTOPE_TIMESCALE_COEFF_C1">BOLIN_ISOTOPE_TIMESCALE_COEFF_C1</a>
</li>
<li>
<a class="variable" href="#PICCIOTTO_18O_A">PICCIOTTO_18O_A</a>
</li>
<li>
<a class="variable" href="#PICCIOTTO_18O_B">PICCIOTTO_18O_B</a>
</li>
<li>
<a class="variable" href="#PICCIOTTO_2H_A">PICCIOTTO_2H_A</a>
</li>
<li>
<a class="variable" href="#PICCIOTTO_2H_B">PICCIOTTO_2H_B</a>
</li>
<li>
<a class="variable" href="#PICCIOTTO_18O_TO_2H_SLOPE_COEFF">PICCIOTTO_18O_TO_2H_SLOPE_COEFF</a>
</li>
<li>
<a class="variable" href="#PICCIOTTO_18O_TO_2H_INTERCEPT_COEFF">PICCIOTTO_18O_TO_2H_INTERCEPT_COEFF</a>
</li>
</ul>


Expand Down Expand Up @@ -1262,6 +1280,25 @@ <h1 class="modulename">
</span><span id="L-437"><a href="#L-437"><span class="linenos">437</span></a><span class="sd">isotopologue; in the paper timescale is calculated for tritium with assumption of no tritium</span>
</span><span id="L-438"><a href="#L-438"><span class="linenos">438</span></a><span class="sd">in the environment around the drop (Table 1).</span>
</span><span id="L-439"><a href="#L-439"><span class="linenos">439</span></a><span class="sd">&quot;&quot;&quot;</span>
</span><span id="L-440"><a href="#L-440"><span class="linenos">440</span></a>
</span><span id="L-441"><a href="#L-441"><span class="linenos">441</span></a><span class="n">PICCIOTTO_18O_A</span> <span class="o">=</span> <span class="o">-</span><span class="mf">0.9</span> <span class="o">*</span> <span class="n">PER_MILLE</span> <span class="o">/</span> <span class="n">si</span><span class="o">.</span><span class="n">K</span>
</span><span id="L-442"><a href="#L-442"><span class="linenos">442</span></a><span class="sd">&quot;&quot;&quot; linear fit coefficients from [Picciotto et al. 1960](https://doi.org/10.1038/187857a0)</span>
</span><span id="L-443"><a href="#L-443"><span class="linenos">443</span></a><span class="sd">for atmospheric temperature inference from water isotopic composition</span>
</span><span id="L-444"><a href="#L-444"><span class="linenos">444</span></a><span class="sd">(note that the sign of A coefficient is opposite to match the paper plot - typo in the paper?) &quot;&quot;&quot;</span>
</span><span id="L-445"><a href="#L-445"><span class="linenos">445</span></a><span class="n">PICCIOTTO_18O_B</span> <span class="o">=</span> <span class="mf">6.4</span> <span class="o">*</span> <span class="n">PER_MILLE</span>
</span><span id="L-446"><a href="#L-446"><span class="linenos">446</span></a><span class="sd">&quot;&quot;&quot;〃&quot;&quot;&quot;</span>
</span><span id="L-447"><a href="#L-447"><span class="linenos">447</span></a><span class="n">PICCIOTTO_2H_A</span> <span class="o">=</span> <span class="o">-</span><span class="mf">0.8</span> <span class="o">*</span> <span class="n">PER_CENT</span> <span class="o">/</span> <span class="n">si</span><span class="o">.</span><span class="n">K</span>
</span><span id="L-448"><a href="#L-448"><span class="linenos">448</span></a><span class="sd">&quot;&quot;&quot;〃&quot;&quot;&quot;</span>
</span><span id="L-449"><a href="#L-449"><span class="linenos">449</span></a><span class="n">PICCIOTTO_2H_B</span> <span class="o">=</span> <span class="mi">8</span> <span class="o">*</span> <span class="n">PER_CENT</span>
</span><span id="L-450"><a href="#L-450"><span class="linenos">450</span></a><span class="sd">&quot;&quot;&quot;〃&quot;&quot;&quot;</span>
</span><span id="L-451"><a href="#L-451"><span class="linenos">451</span></a>
</span><span id="L-452"><a href="#L-452"><span class="linenos">452</span></a><span class="n">PICCIOTTO_18O_TO_2H_SLOPE_COEFF</span> <span class="o">=</span> <span class="mf">0.8</span> <span class="o">*</span> <span class="n">PER_CENT</span> <span class="o">/</span> <span class="n">PER_MILLE</span>
</span><span id="L-453"><a href="#L-453"><span class="linenos">453</span></a><span class="sd">&quot;&quot;&quot; [hydro]meteoric water line [Picciotto et al. 1960](https://doi.org/10.1038/187857a0) coeffs</span>
</span><span id="L-454"><a href="#L-454"><span class="linenos">454</span></a><span class="sd">(note that the delta-2H and delta-18O are swapped to match the paper plot - typo in the paper?)</span>
</span><span id="L-455"><a href="#L-455"><span class="linenos">455</span></a><span class="sd">(note that the sign of INTERCEPT is opposite to match the paper plot - typo in the paper?)</span>
</span><span id="L-456"><a href="#L-456"><span class="linenos">456</span></a><span class="sd">&quot;&quot;&quot;</span>
</span><span id="L-457"><a href="#L-457"><span class="linenos">457</span></a><span class="n">PICCIOTTO_18O_TO_2H_INTERCEPT_COEFF</span> <span class="o">=</span> <span class="o">-</span><span class="mf">1.8</span> <span class="o">*</span> <span class="n">PER_CENT</span>
</span><span id="L-458"><a href="#L-458"><span class="linenos">458</span></a><span class="sd">&quot;&quot;&quot;〃&quot;&quot;&quot;</span>
</span></pre></div>


Expand Down Expand Up @@ -4280,6 +4317,94 @@ <h1 class="modulename">
</div>


</section>
<section id="PICCIOTTO_18O_A">
<div class="attr variable">
<span class="name">PICCIOTTO_18O_A</span> =
<span class="default_value">-0.0009000000000000001</span>


</div>
<a class="headerlink" href="#PICCIOTTO_18O_A"></a>

<div class="docstring"><p>linear fit coefficients from <a href="https://doi.org/10.1038/187857a0">Picciotto et al. 1960</a>
for atmospheric temperature inference from water isotopic composition
(note that the sign of A coefficient is opposite to match the paper plot - typo in the paper?)</p>
</div>


</section>
<section id="PICCIOTTO_18O_B">
<div class="attr variable">
<span class="name">PICCIOTTO_18O_B</span> =
<span class="default_value">0.0064</span>


</div>
<a class="headerlink" href="#PICCIOTTO_18O_B"></a>

<div class="docstring"><p>〃</p>
</div>


</section>
<section id="PICCIOTTO_2H_A">
<div class="attr variable">
<span class="name">PICCIOTTO_2H_A</span> =
<span class="default_value">-0.008</span>


</div>
<a class="headerlink" href="#PICCIOTTO_2H_A"></a>

<div class="docstring"><p>〃</p>
</div>


</section>
<section id="PICCIOTTO_2H_B">
<div class="attr variable">
<span class="name">PICCIOTTO_2H_B</span> =
<span class="default_value">0.08</span>


</div>
<a class="headerlink" href="#PICCIOTTO_2H_B"></a>

<div class="docstring"><p>〃</p>
</div>


</section>
<section id="PICCIOTTO_18O_TO_2H_SLOPE_COEFF">
<div class="attr variable">
<span class="name">PICCIOTTO_18O_TO_2H_SLOPE_COEFF</span> =
<span class="default_value">8.0</span>


</div>
<a class="headerlink" href="#PICCIOTTO_18O_TO_2H_SLOPE_COEFF"></a>

<div class="docstring"><p>[hydro]meteoric water line <a href="https://doi.org/10.1038/187857a0">Picciotto et al. 1960</a> coeffs
(note that the delta-2H and delta-18O are swapped to match the paper plot - typo in the paper?)
(note that the sign of INTERCEPT is opposite to match the paper plot - typo in the paper?)</p>
</div>


</section>
<section id="PICCIOTTO_18O_TO_2H_INTERCEPT_COEFF">
<div class="attr variable">
<span class="name">PICCIOTTO_18O_TO_2H_INTERCEPT_COEFF</span> =
<span class="default_value">-0.018000000000000002</span>


</div>
<a class="headerlink" href="#PICCIOTTO_18O_TO_2H_INTERCEPT_COEFF"></a>

<div class="docstring"><p>〃</p>
</div>


</section>
</main>
<script>
Expand Down
Loading

0 comments on commit fdafd7c

Please sign in to comment.