Skip to content

Commit

Permalink
DOC: Update online doc.
Browse files Browse the repository at this point in the history
  • Loading branch information
MilanSkocic committed Nov 24, 2023
1 parent a723c7b commit 448083e
Show file tree
Hide file tree
Showing 79 changed files with 3,060 additions and 860 deletions.
Binary file modified docs/_downloads/c6590f1cb16fa3c0fab9a03d320b9284/iapws.pdf
Binary file not shown.
Binary file added docs/_images/iapws_r797-regions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 6 additions & 6 deletions docs/_modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview: module code &#8212; iapws 0.2.1 documentation</title>
<title>Overview: module code &#8212; iapws 0.2.2 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b76e3c8a" />
<link rel="stylesheet" type="text/css" href="../_static/classic.css?v=7ea05869" />

<script src="../_static/documentation_options.js?v=37f418d5"></script>
<script src="../_static/documentation_options.js?v=000c92bf"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>

Expand All @@ -24,7 +24,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">iapws 0.2.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">iapws 0.2.2 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Overview: module code</a></li>
</ul>
</div>
Expand All @@ -51,13 +51,13 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">iapws 0.2.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">iapws 0.2.2 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Overview: module code</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2023 Milan Skocic.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.5.
&#169; Copyright .
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
</div>
</body>
</html>
2 changes: 1 addition & 1 deletion docs/_sources/api/iapws.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Fortran
.. literalinclude:: ../../../../src/iapws_g704.f90
:language: Fortran

* `iapws_g704.f90`: C API for the IAPWS module.
* `iapws_g704_capi.f90`: C API for the IAPWS module.

.. literalinclude:: ../../../../src/iapws_g704_capi.f90
:language: Fortran
Expand Down
2 changes: 1 addition & 1 deletion docs/_sources/iapws_theory/iapws_g704.rst.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
IAPWS G7-04
==================

The computation is based on the parameters provided by the IAPWS 2004 :cite:p:`iapws2004`.
The computation is based on the parameters provided by the technical report G7-04 :cite:p:`iapws2004`.

Henry Contant: kh
^^^^^^^^^^^^^^^^^^^^
Expand Down
50 changes: 50 additions & 0 deletions docs/_sources/iapws_theory/iapws_r797.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
IAPWS R7-97
==============

The computation is based on the parameters provided by the technical report R7-97 :cite:p:`iapws2007`.

Structure of the formulation
-------------------------------

The R7-97 report consists of a set of equations for different
regions which cover the following range of validity:

* :math:`273.15K < T < 1073.15K` and :math:`p < 100MPa`
* :math:`1073.15K < T < 2273.15K` and :math:`p < 50MPa`

.. _fig_regions:
.. figure:: ../media/iapws_r797-regions.png
:width: 400
:align: center
:alt: IAPWS R797: Regions

Regions of water defined in R7-97.

Reference constants
----------------------
The specific gas constant of ordinary water used for this formulation is

* :math:`R = 0.461 526\ kJ.kg^{-1}.K^{-1}` (1)

This value results from the recommended values of the molar gas constant [4],
and the molar mass of ordinary water [5, 6]. The values of the critical parameters

* :math:`T_c = 647.096\ K` (2)
* :math:`p_c = 22.064\ MPa` (3)
* :math:`\rho _c = 322\ kg.m^{-3}` (4)

are from the corresponding IAPWS release [7].


Auxiliary Equation for the Boundary between Regions 2 and 3
-------------------------------------------------------------

.. math::
:label: eq_B23_P
\pi = n_1 + n_2 \theta + n_3 \theta ^2
.. math::
:label: eq_B23_T
\theta = n_4 + \left( \frac{\pi - n_5}{n_3} \right)^{1/2}
3 changes: 2 additions & 1 deletion docs/_sources/iapws_theory/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,5 @@ IAPWS - Theoretical background
.. toctree::
:maxdepth: 2

iapws_g704.rst
iapws_g704.rst
.. iapws_r797.rst
29 changes: 29 additions & 0 deletions docs/_sources/releases/0.2.2-notes.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
iapws 0.2.2 Release Note
==================================

Summary
--------

* Implementation of report R283 for critical constants of water.
* Switch to pyproject.toml for python wrapper.
* Code refractoring and clean up.
* Documentation update.

Download
----------

`iapws <https://github.com/MilanSkocic/iapws/releases>`_

`pyiapws <https://pypi.org/project/pyiapws>`_


Contributors
---------------

Milan Skocic


Commits
--------

Full Changelog: https://github.com/MilanSkocic/iapws/compare/0.2.1...0.2.2
1 change: 1 addition & 0 deletions docs/_sources/releases/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ Release Notes
.. toctree::
:maxdepth: 1

0.2.2-notes.rst
0.2.1-notes.rst
0.2.0-notes.rst
0.1.1-notes.rst
Expand Down
2 changes: 1 addition & 1 deletion docs/_static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const DOCUMENTATION_OPTIONS = {
VERSION: '0.2.1',
VERSION: '0.2.2',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
12 changes: 6 additions & 6 deletions docs/api/iapws.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<title>iapws &#8212; iapws 0.2.1 documentation</title>
<title>iapws &#8212; iapws 0.2.2 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b76e3c8a" />
<link rel="stylesheet" type="text/css" href="../_static/classic.css?v=7ea05869" />

<script src="../_static/documentation_options.js?v=37f418d5"></script>
<script src="../_static/documentation_options.js?v=000c92bf"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>

Expand All @@ -33,7 +33,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="index.html" title="API"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">iapws 0.2.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">iapws 0.2.2 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">API</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">iapws</a></li>
</ul>
Expand Down Expand Up @@ -111,14 +111,14 @@ <h3>Navigation</h3>
<li class="right" >
<a href="index.html" title="API"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">iapws 0.2.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">iapws 0.2.2 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="index.html" >API</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">iapws</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2023 Milan Skocic.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.5.
&#169; Copyright .
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
</div>
</body>
</html>
12 changes: 6 additions & 6 deletions docs/api/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<title>API &#8212; iapws 0.2.1 documentation</title>
<title>API &#8212; iapws 0.2.2 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b76e3c8a" />
<link rel="stylesheet" type="text/css" href="../_static/classic.css?v=7ea05869" />

<script src="../_static/documentation_options.js?v=37f418d5"></script>
<script src="../_static/documentation_options.js?v=000c92bf"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>

Expand All @@ -33,7 +33,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../releases/0.1.0-notes.html" title="iapws 0.1.0 Release Note"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">iapws 0.2.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">iapws 0.2.2 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">API</a></li>
</ul>
</div>
Expand Down Expand Up @@ -80,13 +80,13 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../releases/0.1.0-notes.html" title="iapws 0.1.0 Release Note"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">iapws 0.2.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">iapws 0.2.2 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">API</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2023 Milan Skocic.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.5.
&#169; Copyright .
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
</div>
</body>
</html>
12 changes: 6 additions & 6 deletions docs/api/pyiapws.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<title>pyipaws &#8212; iapws 0.2.1 documentation</title>
<title>pyipaws &#8212; iapws 0.2.2 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b76e3c8a" />
<link rel="stylesheet" type="text/css" href="../_static/classic.css?v=7ea05869" />

<script src="../_static/documentation_options.js?v=37f418d5"></script>
<script src="../_static/documentation_options.js?v=000c92bf"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>

Expand All @@ -33,7 +33,7 @@ <h3>Navigation</h3>
<li class="right" >
<a href="iapws.html" title="iapws"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">iapws 0.2.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">iapws 0.2.2 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">API</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">pyipaws</a></li>
</ul>
Expand Down Expand Up @@ -107,14 +107,14 @@ <h3>Navigation</h3>
<li class="right" >
<a href="iapws.html" title="iapws"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">iapws 0.2.1 documentation</a> &#187;</li>
<li class="nav-item nav-item-0"><a href="../index.html">iapws 0.2.2 documentation</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="index.html" >API</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">pyipaws</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2023 Milan Skocic.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.5.
&#169; Copyright .
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
</div>
</body>
</html>
9 changes: 8 additions & 1 deletion docs/ford/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -110,13 +110,19 @@ <h3>Source Files</h3>
<ul> <li><a href='./sourcefile/iapws.f90.html'>iapws.f90</a></li>
<li><a href='./sourcefile/iapws_g704.f90.html'>iapws_g704.f90</a></li>
<li><a href='./sourcefile/iapws_g704_capi.f90.html'>iapws_g704_capi.f90</a></li>
<li><a href='./sourcefile/iapws_r283.f90.html'>iapws_r283.f90</a></li>
<li><a href='./sourcefile/iapws_r283_capi.f90.html'>iapws_r283_capi.f90</a></li>
<li><a href='./sourcefile/iapws_r797.f90.html'>iapws_r797.f90</a></li>
</ul>
</div>
<div class="col-xs-6 col-sm-3">
<h3>Modules</h3>
<ul> <li><a href='./module/iapws.html'>iapws</a></li>
<li><a href='./module/iapws__g704.html'>iapws__g704</a></li>
<li><a href='./module/iapws__g704_capi.html'>iapws__g704_capi</a></li>
<li><a href='./module/iapws__r283.html'>iapws__r283</a></li>
<li><a href='./module/iapws__r283_capi.html'>iapws__r283_capi</a></li>
<li><a href='./module/iapws__r797.html'>iapws__r797</a></li>
</ul>
</div>
<div class="col-xs-6 col-sm-3">
Expand All @@ -130,6 +136,7 @@ <h3>Procedures</h3>
<li><a href='./proc/iapws_g704_kd.html'>iapws_g704_kd</a></li>
<li><a href='./proc/iapws_g704_kh.html'>iapws_g704_kh</a></li>
<li><a href='./proc/iapws_g704_ngases.html'>iapws_g704_ngases</a></li>
<li><a href='./proc/iapws_r797_v.html'>iapws_r797_v</a></li>
</ul>
</div>
<div class="col-xs-6 col-sm-3">
Expand All @@ -150,7 +157,7 @@ <h3>Derived Types</h3>
<p class="text-right">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2023-09-08T06:13:48.047897 </p>
on 2023-11-24T07:07:03.889139 </p>
</div>
</div>
<br>
Expand Down
5 changes: 4 additions & 1 deletion docs/ford/lists/files.html
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,9 @@ <h1>Source Files</h1>
<tr><td><a href='../sourcefile/iapws.f90.html'>iapws.f90</a></td><td></td></tr>
<tr><td><a href='../sourcefile/iapws_g704.f90.html'>iapws_g704.f90</a></td><td></td></tr>
<tr><td><a href='../sourcefile/iapws_g704_capi.f90.html'>iapws_g704_capi.f90</a></td><td></td></tr>
<tr><td><a href='../sourcefile/iapws_r283.f90.html'>iapws_r283.f90</a></td><td></td></tr>
<tr><td><a href='../sourcefile/iapws_r283_capi.f90.html'>iapws_r283_capi.f90</a></td><td></td></tr>
<tr><td><a href='../sourcefile/iapws_r797.f90.html'>iapws_r797.f90</a></td><td></td></tr>
</tbody></table>

</div>
Expand All @@ -101,7 +104,7 @@ <h1>Source Files</h1>
<p class="text-right">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2023-09-08T06:13:48.047897 </p>
on 2023-11-24T07:07:03.889139 </p>
</div>
</div>
<br>
Expand Down
14 changes: 10 additions & 4 deletions docs/ford/lists/modules.html
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,15 @@ <h1>Modules</h1>
<thead><tr><th>Module</th><th>Source File</th><th>Description</th></tr></thead>
<tbody>
<tr class="active"><td><a href='../module/iapws.html'>iapws</a></td><td><a href='../sourcefile/iapws.f90.html'>iapws.f90</a></td><td><p>Main module for the IAPWS library.</p></td></tr>
<!--active--> <tr class=""><td><a href='../module/iapws__g704.html'>iapws__g704</a></td><td><a href='../sourcefile/iapws_g704.f90.html'>iapws_g704.f90</a></td><td><p>Module for IAPWS G7-04</p></td></tr>
<!----> <tr class="active"><td><a href='../module/iapws__g704_capi.html'>iapws__g704_capi</a></td><td><a href='../sourcefile/iapws_g704_capi.f90.html'>iapws_g704_capi.f90</a></td><td><p>C API for the IAPWS module.</p></td></tr>
<!--active--> </tbody></table>
<!--active--> <tr class=""><td><a href='../module/iapws__g704.html'>iapws__g704</a></td><td><a href='../sourcefile/iapws_g704.f90.html'>iapws_g704.f90</a></td><td><p>Module for IAPWS G7-04
EFGH coefficients for gases in heavywater.
ai and bi coefficients for water</p></td></tr>
<!----> <tr class="active"><td><a href='../module/iapws__g704_capi.html'>iapws__g704_capi</a></td><td><a href='../sourcefile/iapws_g704_capi.f90.html'>iapws_g704_capi.f90</a></td><td><p>C API for the G704 module.</p></td></tr>
<!--active--> <tr class=""><td><a href='../module/iapws__r283.html'>iapws__r283</a></td><td><a href='../sourcefile/iapws_r283.f90.html'>iapws_r283.f90</a></td><td><p>Module for IAPWS R283</p></td></tr>
<!----> <tr class="active"><td><a href='../module/iapws__r283_capi.html'>iapws__r283_capi</a></td><td><a href='../sourcefile/iapws_r283_capi.f90.html'>iapws_r283_capi.f90</a></td><td><p>C API for the module R283</p></td></tr>
<!--active--> <tr class=""><td><a href='../module/iapws__r797.html'>iapws__r797</a></td><td><a href='../sourcefile/iapws_r797.f90.html'>iapws_r797.f90</a></td><td><p>Module for IAPWS R7-97
Parameters from IAPWS R7-97</p></td></tr>
<!----> </tbody></table>

</div>
</div>
Expand All @@ -101,7 +107,7 @@ <h1>Modules</h1>
<p class="text-right">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2023-09-08T06:13:48.047897 </p>
on 2023-11-24T07:07:03.889139 </p>
</div>
</div>
<br>
Expand Down
3 changes: 2 additions & 1 deletion docs/ford/lists/procedures.html
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ <h1>Procedures</h1>
<tr><td><a href='../proc/iapws_g704_kd.html'>iapws_g704_kd</a></td><td><a href='../module/iapws__g704.html'>iapws__g704</a></td><td>Subroutine</td><td><p>Compute the vapor-liquid constant for a given temperature. </p></td></tr>
<tr><td><a href='../proc/iapws_g704_kh.html'>iapws_g704_kh</a></td><td><a href='../module/iapws__g704.html'>iapws__g704</a></td><td>Subroutine</td><td><p>Compute the henry constant for a given temperature.</p></td></tr>
<tr><td><a href='../proc/iapws_g704_ngases.html'>iapws_g704_ngases</a></td><td><a href='../module/iapws__g704.html'>iapws__g704</a></td><td>Function</td><td><p>Returns the number of gases.</p></td></tr>
<tr><td><a href='../proc/iapws_r797_v.html'>iapws_r797_v</a></td><td><a href='../module/iapws__r797.html'>iapws__r797</a></td><td>Function</td><td></td></tr>
</tbody></table>

</div>
Expand All @@ -107,7 +108,7 @@ <h1>Procedures</h1>
<p class="text-right">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2023-09-08T06:13:48.047897 </p>
on 2023-11-24T07:07:03.889139 </p>
</div>
</div>
<br>
Expand Down
Loading

0 comments on commit 448083e

Please sign in to comment.