DOC: Update documentation.

MilanSkocic · Jun 17, 2024 · be9f217 · be9f217
1 parent 36a8fa9
commit be9f217
Show file tree

Hide file tree

Showing 53 changed files with 2,281 additions and 1,650 deletions.
diff --git a/doc/changelog.md b/doc/changelog.md
@@ -2,6 +2,8 @@
 title: Changelog
 ---
 
+[TOC]
+
 {!CHANGELOG.md!}
 
 
diff --git a/doc/examples.md b/doc/examples.md
@@ -0,0 +1,24 @@
+---
+title: Examples
+---
+
+[TOC]
+
+# Fortran
+
+```fortran
+{!example/example.f90!}
+```
+
+# C
+
+```C
+{!example/example.c!}
+```
+
+
+# Python
+
+```python
+{!example/example.py!}
+```
diff --git a/doc/specs/capi.md b/doc/specs/capi.md
@@ -2,6 +2,7 @@
 title: C API
 ---
 
+The prototypes of the C API are defined as shown below.
 
 ```c
 {!include/iapws.h!}

diff --git a/doc/specs/index.md b/doc/specs/index.md
@@ -7,3 +7,4 @@ This is an index/directory of the specifications (specs) for each module.
  - [R2-83](./iapws_r283.html) - Values of Temperature, Pressure and Density of Ordinary and Heavy Water Substances at Their Respective Critical Points
  - [G7-04](./iapws_g704.html) - Guideline on the Henry’s Constant and Vapor-Liquid Distribution Constant for Gases in H2O and D2O at High Temperatures
  - [R7-97](./iapws_r797.html) - Revised Release on the IAPWS Industrial Formulation 1997 for the Thermodynamic Properties of Water and Steam
+ - [C API](./capi.html) - Prototypes for C language.
diff --git a/docs/index.html b/docs/index.html
@@ -90,7 +90,9 @@ <h1>iapws</h1>
 </div>
 <h1 id="introduction">Introduction</h1>
 <p><code>ipaws</code> is a  Fortran library providing the formulas for computing light and heavy water properties.
-The formulas are taken from http://iapws.org. </p>
+The formulas are taken from http://iapws.org. 
+C API allows usage from C, or can be used as a basis for other wrappers.
+Python wrapper allows easy usage from Python.</p>
 <p>For now, I have implemented the technical report G7-04 for gas solubility. I plan to implement the 
 technical report R7-97. </p>
 <p>To use <code>iapws</code> within your <code>fpm &lt;https://github.com/fortran-lang/fpm&gt;</code>_ project,
@@ -100,11 +102,6 @@ <h1 id="introduction">Introduction</h1>
 <span class="na">iapws</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">{ git=&quot;https://github.com/MilanSkocic/iapws.git&quot; }</span>
 </code></pre></div>
 
-<p>Optional thin wrappers allow usage of the library from other languages, e.g.:</p>
-<ul>
-<li><a href="https://github.com/MilanSkocic/iapws-capi">C wrapper</a></li>
-<li><a href="https://github.com/MilanSkocic/iapws-py">Python wrapper</a></li>
-</ul>
 <h1 id="dependencies">Dependencies</h1>
 <div class="codehilite"><pre><span></span><code>gcc&gt;=10.0
 gfortran&gt;=10.0
@@ -220,7 +217,7 @@ <h3>Derived Types</h3>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-06-16T10:30:48.482165             </p>
+ on 2024-06-17T10:30:15.142000             </p>
           </div>
         </div>
         <br>

diff --git a/docs/lists/files.html b/docs/lists/files.html
diff --git a/docs/lists/modules.html b/docs/lists/modules.html
diff --git a/docs/lists/procedures.html b/docs/lists/procedures.html
diff --git a/docs/lists/types.html b/docs/lists/types.html
@@ -95,7 +95,7 @@ <h1>Derived Types</h1>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-06-16T10:30:48.482165             </p>
+ on 2024-06-17T10:30:15.142000             </p>
           </div>
         </div>
         <br>

diff --git a/docs/module/capi.html b/docs/module/capi.html
diff --git a/docs/module/capi__g704.html b/docs/module/capi__g704.html
diff --git a/docs/module/capi__r783.html b/docs/module/capi__r783.html
diff --git a/docs/module/capi__version.html b/docs/module/capi__version.html
diff --git a/docs/module/iapws.html b/docs/module/iapws.html
diff --git a/docs/module/iapws__g704.html b/docs/module/iapws__g704.html
diff --git a/docs/module/iapws__r283.html b/docs/module/iapws__r283.html
diff --git a/docs/module/iapws__r797.html b/docs/module/iapws__r797.html
@@ -152,57 +152,57 @@ <h3 class="card-header card-title bg-light">Uses</h3>
         <ul class="list-group list-group-flush">
             <li class="list-group-item">
               <ul class="list-inline">
-                  <li class="list-inline-item"><a href='http://fortranwiki.org/fortran/show/iso_fortran_env'>iso_fortran_env</a></li>
                   <li class="list-inline-item"><a href='http://fortranwiki.org/fortran/show/ieee_arithmetic'>ieee_arithmetic</a></li>
+                  <li class="list-inline-item"><a href='http://fortranwiki.org/fortran/show/iso_fortran_env'>iso_fortran_env</a></li>
               </ul>
             </li>
             <li class="list-group-item">
               <div class="depgraph"><?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
  "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
-<!-- Generated by graphviz version 11.0.0 (0)
+<!-- Generated by graphviz version 2.43.0 (0)
  -->
 <!-- Title: module~~iapws__r797~~UsesGraph Pages: 1 -->
-<svg id="moduleiapws__r797UsesGraph" width="202pt" height="74pt"
- viewBox="0.00 0.00 202.04 73.52" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
-<g id="module~~iapws__r797~~UsesGraph" class="graph" transform="scale(1 1) rotate(0) translate(4 69.52)">
+<svg id="moduleiapws__r797UsesGraph" width="218pt" height="74pt"
+ viewBox="0.00 0.00 218.00 74.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+<g id="module~~iapws__r797~~UsesGraph" class="graph" transform="scale(1 1) rotate(0) translate(4 70)">
 <title>module~~iapws__r797~~UsesGraph</title>
-<polygon fill="white" stroke="none" points="-4,4 -4,-69.52 198.04,-69.52 198.04,4 -4,4"/>
+<polygon fill="white" stroke="transparent" points="-4,4 -4,-70 214,-70 214,4 -4,4"/>
 <!-- module~iapws__r797 -->
 <g id="module~~iapws__r797~~UsesGraph_node1" class="node">
 <title>module~iapws__r797</title>
-<polygon fill="none" stroke="black" points="194.04,-44.52 121.77,-44.52 121.77,-21 194.04,-21 194.04,-44.52"/>
-<text text-anchor="middle" x="157.91" y="-28.78" font-family="Helvetica,sans-Serif" font-size="10.50">iapws__r797</text>
+<polygon fill="none" stroke="black" points="210,-45 132,-45 132,-21 210,-21 210,-45"/>
+<text text-anchor="middle" x="171" y="-30.6" font-family="Helvetica,sans-Serif" font-size="10.50">iapws__r797</text>
 </g>
 <!-- ieee_arithmetic -->
 <g id="module~~iapws__r797~~UsesGraph_node2" class="node">
 <title>ieee_arithmetic</title>
 <g id="a_module~~iapws__r797~~UsesGraph_node2"><a xlink:href="http://fortranwiki.org/fortran/show/ieee_arithmetic" xlink:title="ieee_arithmetic">
-<polygon fill="#337ab7" stroke="#337ab7" points="85.02,-65.52 0.75,-65.52 0.75,-42 85.02,-42 85.02,-65.52"/>
-<text text-anchor="middle" x="42.88" y="-49.78" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">ieee_arithmetic</text>
+<polygon fill="#337ab7" stroke="#337ab7" points="96,-66 0,-66 0,-42 96,-42 96,-66"/>
+<text text-anchor="middle" x="48" y="-51.6" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">ieee_arithmetic</text>
 </a>
 </g>
 </g>
 <!-- module~iapws__r797&#45;&gt;ieee_arithmetic -->
 <g id="module~~iapws__r797~~UsesGraph_edge1" class="edge">
 <title>module~iapws__r797&#45;&gt;ieee_arithmetic</title>
-<path fill="none" stroke="#ff0000" stroke-dasharray="5,2" d="M121.45,-39.35C113.44,-40.84 104.77,-42.45 96.23,-44.03"/>
-<polygon fill="#ff0000" stroke="#ff0000" points="95.82,-40.55 86.62,-45.82 97.1,-47.43 95.82,-40.55"/>
+<path fill="none" stroke="#ff0000" stroke-dasharray="5,2" d="M131.71,-39.64C123.65,-41.04 114.98,-42.55 106.39,-44.04"/>
+<polygon fill="#ff0000" stroke="#ff0000" points="105.64,-40.62 96.39,-45.78 106.84,-47.51 105.64,-40.62"/>
 </g>
 <!-- iso_fortran_env -->
 <g id="module~~iapws__r797~~UsesGraph_node3" class="node">
 <title>iso_fortran_env</title>
 <g id="a_module~~iapws__r797~~UsesGraph_node3"><a xlink:href="http://fortranwiki.org/fortran/show/iso_fortran_env" xlink:title="iso_fortran_env">
-<polygon fill="#337ab7" stroke="#337ab7" points="85.77,-23.52 0,-23.52 0,0 85.77,0 85.77,-23.52"/>
-<text text-anchor="middle" x="42.88" y="-7.78" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">iso_fortran_env</text>
+<polygon fill="#337ab7" stroke="#337ab7" points="95,-24 1,-24 1,0 95,0 95,-24"/>
+<text text-anchor="middle" x="48" y="-9.6" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">iso_fortran_env</text>
 </a>
 </g>
 </g>
 <!-- module~iapws__r797&#45;&gt;iso_fortran_env -->
 <g id="module~~iapws__r797~~UsesGraph_edge2" class="edge">
 <title>module~iapws__r797&#45;&gt;iso_fortran_env</title>
-<path fill="none" stroke="#ff0000" stroke-dasharray="5,2" d="M121.45,-26.17C113.71,-24.73 105.35,-23.18 97.09,-21.65"/>
-<polygon fill="#ff0000" stroke="#ff0000" points="97.9,-18.24 87.43,-19.85 96.62,-25.12 97.9,-18.24"/>
+<path fill="none" stroke="#ff0000" stroke-dasharray="5,2" d="M131.71,-26.36C123.26,-24.89 114.14,-23.31 105.15,-21.74"/>
+<polygon fill="#ff0000" stroke="#ff0000" points="105.54,-18.26 95.09,-20 104.34,-25.16 105.54,-18.26"/>
 </g>
 </g>
 </svg>
@@ -221,49 +221,49 @@ <h4 class="modal-title" id="-graph-help-label">Graph Key</h4>
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
  "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
-<!-- Generated by graphviz version 11.0.0 (0)
+<!-- Generated by graphviz version 2.43.0 (0)
  -->
 <!-- Title: Graph Key Pages: 1 -->
-<svg width="485pt" height="32pt"
- viewBox="0.00 0.00 485.13 31.52" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
-<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 27.52)">
+<svg width="518pt" height="32pt"
+ viewBox="0.00 0.00 517.50 32.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 28)">
 <title>Graph Key</title>
-<polygon fill="white" stroke="none" points="-4,4 -4,-27.52 481.13,-27.52 481.13,4 -4,4"/>
+<polygon fill="white" stroke="transparent" points="-4,4 -4,-28 513.5,-28 513.5,4 -4,4"/>
 <!-- Module -->
 <g id="node1" class="node">
 <title>Module</title>
-<polygon fill="#337ab7" stroke="#337ab7" points="54,-23.52 0,-23.52 0,0 54,0 54,-23.52"/>
-<text text-anchor="middle" x="27" y="-7.78" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">Module</text>
+<polygon fill="#337ab7" stroke="#337ab7" points="54,-24 0,-24 0,0 54,0 54,-24"/>
+<text text-anchor="middle" x="27" y="-9.6" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">Module</text>
 </g>
 <!-- Submodule -->
 <g id="node2" class="node">
 <title>Submodule</title>
-<polygon fill="#5bc0de" stroke="#5bc0de" points="137.76,-23.52 72.24,-23.52 72.24,0 137.76,0 137.76,-23.52"/>
-<text text-anchor="middle" x="105" y="-7.78" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">Submodule</text>
+<polygon fill="#5bc0de" stroke="#5bc0de" points="145.5,-24 72.5,-24 72.5,0 145.5,0 145.5,-24"/>
+<text text-anchor="middle" x="109" y="-9.6" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">Submodule</text>
 </g>
 <!-- Subroutine -->
 <g id="node3" class="node">
 <title>Subroutine</title>
-<polygon fill="#d9534f" stroke="#d9534f" points="218.63,-23.52 155.37,-23.52 155.37,0 218.63,0 218.63,-23.52"/>
-<text text-anchor="middle" x="187" y="-7.78" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">Subroutine</text>
+<polygon fill="#d9534f" stroke="#d9534f" points="234,-24 164,-24 164,0 234,0 234,-24"/>
+<text text-anchor="middle" x="199" y="-9.6" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">Subroutine</text>
 </g>
 <!-- Function -->
 <g id="node4" class="node">
 <title>Function</title>
-<polygon fill="#d94e8f" stroke="#d94e8f" points="291,-23.52 237,-23.52 237,0 291,0 291,-23.52"/>
-<text text-anchor="middle" x="264" y="-7.78" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">Function</text>
+<polygon fill="#d94e8f" stroke="#d94e8f" points="310,-24 252,-24 252,0 310,0 310,-24"/>
+<text text-anchor="middle" x="281" y="-9.6" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">Function</text>
 </g>
 <!-- Program -->
 <g id="node5" class="node">
 <title>Program</title>
-<polygon fill="#f0ad4e" stroke="#f0ad4e" points="363,-23.52 309,-23.52 309,0 363,0 363,-23.52"/>
-<text text-anchor="middle" x="336" y="-7.78" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">Program</text>
+<polygon fill="#f0ad4e" stroke="#f0ad4e" points="386,-24 328,-24 328,0 386,0 386,-24"/>
+<text text-anchor="middle" x="357" y="-9.6" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">Program</text>
 </g>
 <!-- This Page&#39;s Entity -->
 <g id="node6" class="node">
 <title>This Page&#39;s Entity</title>
-<polygon fill="none" stroke="black" points="477.13,-23.52 380.87,-23.52 380.87,0 477.13,0 477.13,-23.52"/>
-<text text-anchor="middle" x="429" y="-7.78" font-family="Helvetica,sans-Serif" font-size="10.50">This Page&#39;s Entity</text>
+<polygon fill="none" stroke="black" points="509.5,-24 404.5,-24 404.5,0 509.5,0 509.5,-24"/>
+<text text-anchor="middle" x="457" y="-9.6" font-family="Helvetica,sans-Serif" font-size="10.50">This Page&#39;s Entity</text>
 </g>
 </g>
 </svg>
@@ -329,7 +329,7 @@ <h4>Arguments</h4>
         </tr>
         <tr>
             <td>
-              <span class="anchor" id="variable-t~3"></span>
+              <span class="anchor" id="variable-t~15"></span>
               real(kind=real64),
             </td>
 <td>intent(in)</td>
@@ -378,7 +378,7 @@ <h4>
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-06-16T10:30:48.482165             </p>
+ on 2024-06-17T10:30:15.142000             </p>
           </div>
         </div>
         <br>