DOC: Generate online documentation.

MilanSkocic · Dec 17, 2023 · 8693d5b · 8693d5b
1 parent 4603938
commit 8693d5b
Show file tree

Hide file tree

Showing 172 changed files with 20,217 additions and 0 deletions.
diff --git a/docs/_downloads/a3e9e0886b7059d4c553af028824283a/LICENSE.txt b/docs/_downloads/a3e9e0886b7059d4c553af028824283a/LICENSE.txt
diff --git a/docs/_downloads/aeeecbf1565d1f259d485137e17b99fb/LICENSE.txt b/docs/_downloads/aeeecbf1565d1f259d485137e17b99fb/LICENSE.txt
diff --git a/docs/_downloads/c6590f1cb16fa3c0fab9a03d320b9284/iapws.pdf b/docs/_downloads/c6590f1cb16fa3c0fab9a03d320b9284/iapws.pdf
diff --git a/docs/_images/g704_kd_D2O.png b/docs/_images/g704_kd_D2O.png
diff --git a/docs/_images/g704_kd_H2O.png b/docs/_images/g704_kd_H2O.png
diff --git a/docs/_images/g704_kh_D2O.png b/docs/_images/g704_kh_D2O.png
diff --git a/docs/_images/g704_kh_H2O.png b/docs/_images/g704_kh_H2O.png
diff --git a/docs/_images/iapws_r797-regions.png b/docs/_images/iapws_r797-regions.png
diff --git a/docs/_images/logo-iapws.png b/docs/_images/logo-iapws.png
diff --git a/docs/_images/math/036fd6d2be6a1347316dcf1e5e202270d708fca8.png b/docs/_images/math/036fd6d2be6a1347316dcf1e5e202270d708fca8.png
diff --git a/docs/_images/math/045f714bd70e021b2406e0439db8d07728df28fe.png b/docs/_images/math/045f714bd70e021b2406e0439db8d07728df28fe.png
diff --git a/docs/_images/math/0f8b9c8bc27720094351e9c1a4be3b8e27af259a.png b/docs/_images/math/0f8b9c8bc27720094351e9c1a4be3b8e27af259a.png
diff --git a/docs/_images/math/1ce400c34295480d5eeed6c2f4a0c01de811df7c.png b/docs/_images/math/1ce400c34295480d5eeed6c2f4a0c01de811df7c.png
diff --git a/docs/_images/math/22d197d0ac78baf6bd6bd2a14153107490411a18.png b/docs/_images/math/22d197d0ac78baf6bd6bd2a14153107490411a18.png
diff --git a/docs/_images/math/2e7e81f57708c7066f107556a8a535b4ab66d236.png b/docs/_images/math/2e7e81f57708c7066f107556a8a535b4ab66d236.png
diff --git a/docs/_images/math/349f39ce1b19cbb1ec1db2d0d4e9db0daf86f905.png b/docs/_images/math/349f39ce1b19cbb1ec1db2d0d4e9db0daf86f905.png
diff --git a/docs/_images/math/4a2c91f3a2b8d84b28c2c88d4df88f78ade951b9.png b/docs/_images/math/4a2c91f3a2b8d84b28c2c88d4df88f78ade951b9.png
diff --git a/docs/_images/math/58af0c1791abd54e34aae6757ab2ee1104de959c.png b/docs/_images/math/58af0c1791abd54e34aae6757ab2ee1104de959c.png
diff --git a/docs/_images/math/5a939c5280da7202ca4531f175a7780ad5e1f80a.png b/docs/_images/math/5a939c5280da7202ca4531f175a7780ad5e1f80a.png
diff --git a/docs/_images/math/5f1155afca054166ee4e920640699305c28ec250.png b/docs/_images/math/5f1155afca054166ee4e920640699305c28ec250.png
diff --git a/docs/_images/math/6226595ad2a6fda37fd37c591b8ab1b67a93ea46.png b/docs/_images/math/6226595ad2a6fda37fd37c591b8ab1b67a93ea46.png
diff --git a/docs/_images/math/718c43e384adc07a88378d28a2e9b8dbbf831535.png b/docs/_images/math/718c43e384adc07a88378d28a2e9b8dbbf831535.png
diff --git a/docs/_images/math/71b2c726f13efbb24229a93562a08659cac42815.png b/docs/_images/math/71b2c726f13efbb24229a93562a08659cac42815.png
diff --git a/docs/_images/math/7802b612c189390a4580013c0fb78e98618b1552.png b/docs/_images/math/7802b612c189390a4580013c0fb78e98618b1552.png
diff --git a/docs/_images/math/8bba708bfd9e1df2575d817c79ab6ae0139b20c6.png b/docs/_images/math/8bba708bfd9e1df2575d817c79ab6ae0139b20c6.png
diff --git a/docs/_images/math/90be5a7adcaf30bf63fc71bda0acda5e2f474a3c.png b/docs/_images/math/90be5a7adcaf30bf63fc71bda0acda5e2f474a3c.png
diff --git a/docs/_images/math/93d91f4402097c53535e940ca374bbfede5dd056.png b/docs/_images/math/93d91f4402097c53535e940ca374bbfede5dd056.png
diff --git a/docs/_images/math/9a21aec4ba10d1512718b78998b101e3a15d8e5e.png b/docs/_images/math/9a21aec4ba10d1512718b78998b101e3a15d8e5e.png
diff --git a/docs/_images/math/9d524c9c7f9cf97e6764c8934576ac9b00a1594b.png b/docs/_images/math/9d524c9c7f9cf97e6764c8934576ac9b00a1594b.png
diff --git a/docs/_images/math/9ffea4b06b04a7fc821d4fb2643264181c698106.png b/docs/_images/math/9ffea4b06b04a7fc821d4fb2643264181c698106.png
diff --git a/docs/_images/math/a09a42b7c684f243785b815cb0353c5413298c14.png b/docs/_images/math/a09a42b7c684f243785b815cb0353c5413298c14.png
diff --git a/docs/_images/math/a5fa84b363f309ebc8fe7db38304541732c7de9a.png b/docs/_images/math/a5fa84b363f309ebc8fe7db38304541732c7de9a.png
diff --git a/docs/_images/math/ac244badcd47cd992eb34566c4072bd9592059ca.png b/docs/_images/math/ac244badcd47cd992eb34566c4072bd9592059ca.png
diff --git a/docs/_images/math/b259f8a66b0588bc7a12cfa6261ea2233b91e7b7.png b/docs/_images/math/b259f8a66b0588bc7a12cfa6261ea2233b91e7b7.png
diff --git a/docs/_images/math/b7bda214149c6fe0d7c6c494b0c896805bf51262.png b/docs/_images/math/b7bda214149c6fe0d7c6c494b0c896805bf51262.png
diff --git a/docs/_images/math/bb032e40c31c39815e3ca9d844e2ababda7059f3.png b/docs/_images/math/bb032e40c31c39815e3ca9d844e2ababda7059f3.png
diff --git a/docs/_images/math/bd2681c96d49c252ac2c7ac31fe3ab11af959859.png b/docs/_images/math/bd2681c96d49c252ac2c7ac31fe3ab11af959859.png
diff --git a/docs/_images/math/c1cae8cabfd7360430bf2220c2bd717db87d9614.png b/docs/_images/math/c1cae8cabfd7360430bf2220c2bd717db87d9614.png
diff --git a/docs/_images/math/ca28b53554b735e9d40e96303676a4a6450f340a.png b/docs/_images/math/ca28b53554b735e9d40e96303676a4a6450f340a.png
diff --git a/docs/_images/math/e4d713f619d94afa02db0303305cbd55896b5d0b.png b/docs/_images/math/e4d713f619d94afa02db0303305cbd55896b5d0b.png
diff --git a/docs/_images/math/e4d90a58338e8ef97fc307fa3b95f6fe4aeaa97f.png b/docs/_images/math/e4d90a58338e8ef97fc307fa3b95f6fe4aeaa97f.png
diff --git a/docs/_images/math/e97052bb6fed48da8b4e12328ce0c890780e44a9.png b/docs/_images/math/e97052bb6fed48da8b4e12328ce0c890780e44a9.png
diff --git a/docs/_images/math/ed38fa24f1c94891bd312012aab3f6673be3eb83.png b/docs/_images/math/ed38fa24f1c94891bd312012aab3f6673be3eb83.png
diff --git a/docs/_images/math/edd4359a33019e2ad319666dae51160aac14cf8c.png b/docs/_images/math/edd4359a33019e2ad319666dae51160aac14cf8c.png
diff --git a/docs/_images/math/ee10016037cad9575a47e6d7a44dbc867d96ecfc.png b/docs/_images/math/ee10016037cad9575a47e6d7a44dbc867d96ecfc.png
diff --git a/docs/_images/math/ee423da3aced7f3589ecbe50124d8563a558c5a6.png b/docs/_images/math/ee423da3aced7f3589ecbe50124d8563a558c5a6.png
diff --git a/docs/_images/math/f28f4009320819a367c478c28cc9d8830bbe360e.png b/docs/_images/math/f28f4009320819a367c478c28cc9d8830bbe360e.png
diff --git a/docs/_images/math/f4a3470b307d3c8e64c9573c629ce41b2c65dcd6.png b/docs/_images/math/f4a3470b307d3c8e64c9573c629ce41b2c65dcd6.png
diff --git a/docs/_images/math/f5f424471e1f942a67eedbdbb512954c4e722fe8.png b/docs/_images/math/f5f424471e1f942a67eedbdbb512954c4e722fe8.png
diff --git a/docs/_images/math/ffbfb1be94728ccddf2d8877eef911c5e6fc6cd4.png b/docs/_images/math/ffbfb1be94728ccddf2d8877eef911c5e6fc6cd4.png
diff --git a/docs/_modules/index.html b/docs/_modules/index.html
@@ -0,0 +1,63 @@
+<!DOCTYPE html>
+
+<html lang="en" data-content_root="../">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <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=000c92bf"></script>
+    <script src="../_static/doctools.js?v=888ff710"></script>
+    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" /> 
+  </head><body>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <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.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">Overview: module code</a></li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+          <div class="body" role="main">
+
+  <h1>All modules for which code is available</h1>
+<ul><li><a href="pyiapws/g704.html">pyiapws.g704</a></li>
+</ul>
+
+            <div class="clearer"></div>
+          </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="../genindex.html" title="General Index"
+             >index</a></li>
+        <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.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 .
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
+    </div>
+  </body>
+</html>
diff --git a/docs/_sources/api/iapws.rst.txt b/docs/_sources/api/iapws.rst.txt
@@ -0,0 +1,68 @@
+iapws
+===============
+
+Fortran
+--------------
+
+.. only:: html
+
+    `Fortran code API <../ford/index.html>`_
+
+.. only:: latex
+
+    * `iapws.f90`: Main module for the whole library.
+
+    .. literalinclude:: ../../../../src/iapws_g704.f90
+        :language: Fortran
+
+    IAPWS R283: Critical Constants
+    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+    * `iapws_r283.f90`: Module for IAPWS R2-83
+
+    .. literalinclude:: ../../../../src/iapws_r283.f90
+        :language: Fortran
+
+    * `iapws_r283_capi.f90`: C API for IAPWS R2-83.
+
+    .. literalinclude:: ../../../../src/iapws_r283_capi.f90
+        :language: Fortran
+
+    IAPWS G704: Gas solubilities
+    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+    * `iapws_g704.f90`: Module for IAPWS G7-04
+
+    .. literalinclude:: ../../../../src/iapws_g704.f90
+        :language: Fortran
+
+    * `iapws_g704_capi.f90`: C API for IAPWS G7-04.
+
+    .. literalinclude:: ../../../../src/iapws_g704_capi.f90
+        :language: Fortran
+
+C
+------
+
+* `iapws.h`: Main C header for the whole library.
+
+.. literalinclude:: ../../../../include/iapws.h
+    :language:  C
+
+.. _iapws_r283_capi:
+
+IAPWS R283: Critical Constants
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+* `iapws_r283.h`: C header.
+
+.. literalinclude:: ../../../../include/iapws_r283.h
+    :language: C
+
+IAPWS G704: Gas solubilities
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+* `iapws_g704.h`: C header.
+
+.. literalinclude:: ../../../../include/iapws_g704.h
+    :language: C
diff --git a/docs/_sources/api/index.rst.txt b/docs/_sources/api/index.rst.txt
@@ -0,0 +1,8 @@
+API
+==================================
+
+.. toctree::
+    :maxdepth: 2
+
+    iapws.rst
+    pyiapws.rst
diff --git a/docs/_sources/api/pyiapws.rst.txt b/docs/_sources/api/pyiapws.rst.txt
@@ -0,0 +1,17 @@
+pyipaws
+================
+
+IAPWS R283: Critical Constants
+----------------------------------
+
+.. automodule:: pyiapws.r283
+    :members:
+
+The constants are defined as in the :ref:`C header <iapws_r283_capi>` without
+the prefix *iapws_r283_capi_*.
+
+IAPWS G704: Gas solubilities
+-------------------------------
+
+.. automodule:: pyiapws.g704
+    :members:
diff --git a/docs/_sources/getting_started/examples.rst.txt b/docs/_sources/getting_started/examples.rst.txt
@@ -0,0 +1,22 @@
+Examples
+===========
+
+
+Example in Fortran
+------------------------------------------
+
+.. literalinclude:: ../../../../example/example_in_f.f90
+    :language: fortran
+
+Example in C
+------------------------------------------
+
+.. literalinclude:: ../../../../example/example_in_c.c
+    :language: C
+
+
+Example in Python
+------------------------------------------
+
+.. literalinclude:: ../../../../example/example_in_py.py
+    :language: python
diff --git a/docs/_sources/getting_started/iapws.rst.txt b/docs/_sources/getting_started/iapws.rst.txt
@@ -0,0 +1,25 @@
+iapw
+==============
+
+.. image:: ../media/logo-iapws.png
+  :width: 200
+  :align: center
+
+.. include:: ../../../../README.rst
+  :start-after: readme_inclusion_start
+  :end-before: readme_inclusion_end
+
+How to install
+^^^^^^^^^^^^^^^^^
+
+.. include:: ../../../../INSTALL.rst
+
+Dependencies
+^^^^^^^^^^^^^^^^^
+
+.. literalinclude:: ../../../../REQUIREMENTS.txt
+
+License
+^^^^^^^^^^^^^^^^^
+
+:download:`GNU General Public License v3 (GPLv3) <../../../../LICENSE.txt>`
diff --git a/docs/_sources/getting_started/index.rst.txt b/docs/_sources/getting_started/index.rst.txt
@@ -0,0 +1,15 @@
+Getting Started
+================
+
+.. only:: html
+
+  PDF documentation: :download:`iapws <../../build/latex/iapws.pdf>`. 
+
+Sources: https://github.com/MilanSkocic/iapws
+
+.. toctree::
+    :maxdepth: 2
+
+    iapws.rst
+    pyiapws.rst
+    examples.rst
diff --git a/docs/_sources/getting_started/pyiapws.rst.txt b/docs/_sources/getting_started/pyiapws.rst.txt
@@ -0,0 +1,21 @@
+pyiapws
+=========================
+
+.. include:: ../../../../pywrapper/README.rst
+  :start-after: readme_inclusion_start
+  :end-before: readme_inclusion_end
+
+How to install
+^^^^^^^^^^^^^^^
+
+.. include:: ../../../../pywrapper/INSTALL.rst
+
+Dependencies
+^^^^^^^^^^^^^^^
+
+.. literalinclude:: ../../../../pywrapper/requirements.txt
+
+License
+^^^^^^^^^^^^^^^
+
+:download:`GNU General Public License v3 (GPLv3) <../../../../pywrapper/LICENSE.txt>`