Skip to content

Commit

Permalink
Update online documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
@MilanSkocic
MilanSkocic committed Jul 4, 2024
1 parent 7c74cb5 commit d85bc04
Show file tree
Hide file tree
Showing 50 changed files with 3,780 additions and 3,800 deletions.
Binary file modified docs/favicon.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ <h1 id="introduction">Introduction</h1>
The formulas are taken from http://ciaaw.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>To use <code>ciaaw</code> within your <code>fpm &lt;https://github.com/fortran-lang/fpm&gt;</code>_ project,
<p>To use <code>ciaaw</code> within your <a href="https://github.com/fortran-lang/fpm">fpm</a> project,
add the following to your <code>fpm.toml</code> file:</p>
<div class="codehilite"><pre><span></span><code><span class="w"> </span><span class="o">[</span><span class="n">dependencies</span><span class="o">]</span>
<span class="w"> </span><span class="n">iapws</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="err">{</span><span class="w"> </span><span class="n">git</span><span class="o">=</span><span class="ss">&quot;https://github.com/MilanSkocic/ciaaw.git&quot;</span><span class="w"> </span><span class="err">}</span>
Expand Down Expand Up @@ -170,7 +170,7 @@ <h3>Source Files</h3>
<div class="col-xs-6 col-sm-3">
<div>
<h3>Modules</h3>
<ul><li><a href='module/capi.html'>capi</a></li><li><a href='module/capi__saw.html'>capi__saw</a></li><li><a href='module/capi__saw_2021.html'>capi__saw_2021</a></li><li><a href='module/capi__saw_type.html'>capi__saw_type</a></li><li><a href='module/capi__version.html'>capi__version</a></li><li><a href='module/ciaaw.html'>ciaaw</a></li><li><a href='module/ciaaw__saw.html'>ciaaw__saw</a></li><li><a href='module/ciaaw__saw_2021.html'>ciaaw__saw_2021</a></li><li><a href='module/ciaaw__saw_type.html'>ciaaw__saw_type</a></li><li><a href='module/ciaaw__version.html'>ciaaw__version</a></li></ul>
<ul><li><a href='module/ciaaw.html'>ciaaw</a></li><li><a href='module/ciaaw__capi.html'>ciaaw__capi</a></li><li><a href='module/ciaaw__capi_saw.html'>ciaaw__capi_saw</a></li><li><a href='module/ciaaw__capi_saw_2021.html'>ciaaw__capi_saw_2021</a></li><li><a href='module/ciaaw__capi_saw_type.html'>ciaaw__capi_saw_type</a></li><li><a href='module/ciaaw__capi_version.html'>ciaaw__capi_version</a></li><li><a href='module/ciaaw__saw.html'>ciaaw__saw</a></li><li><a href='module/ciaaw__saw_2021.html'>ciaaw__saw_2021</a></li><li><a href='module/ciaaw__saw_type.html'>ciaaw__saw_type</a></li><li><a href='module/ciaaw__version.html'>ciaaw__version</a></li></ul>
</div>
<div>
<ul>
Expand Down Expand Up @@ -216,7 +216,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-22T23:27:42.376306 </p>
on 2024-07-04T06:17:33.738233 </p>
</div>
</div>
<br>
Expand Down
122 changes: 61 additions & 61 deletions docs/lists/files.html
View file

Large diffs are not rendered by default.

370 changes: 184 additions & 186 deletions docs/lists/modules.html
View file

Large diffs are not rendered by default.

64 changes: 32 additions & 32 deletions docs/lists/procedures.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ <h1>Procedures</h1>
<tbody>
<tr>
<td><a href='../proc/capi_get_version.html'>capi_get_version</a></td>
<td><a href='../module/capi__version.html'>capi__version</a></td>
<td><a href='../module/ciaaw__capi_version.html'>ciaaw__capi_version</a></td>
<td>Function</td>
<td><p>Get the version</p></td>
</tr>
Expand All @@ -85,37 +85,37 @@ <h1>Procedures</h1>
<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 (20240428.1522)
<!-- Generated by graphviz version 11.0.0 (0)
-->
<!-- Title: call~~graph~~CallGraph Pages: 1 -->
<svg id="callgraphCallGraph" width="204pt" height="31pt"
viewBox="0.00 0.00 203.54 30.77" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="call~~graph~~CallGraph" class="graph" transform="scale(1 1) rotate(0) translate(4 26.77)">
<svg id="callgraphCallGraph" width="204pt" height="32pt"
viewBox="0.00 0.00 203.54 31.52" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="call~~graph~~CallGraph" class="graph" transform="scale(1 1) rotate(0) translate(4 27.52)">
<title>call~~graph~~CallGraph</title>
<polygon fill="white" stroke="none" points="-4,4 -4,-26.77 199.54,-26.77 199.54,4 -4,4"/>
<polygon fill="white" stroke="none" points="-4,4 -4,-27.52 199.54,-27.52 199.54,4 -4,4"/>
<!-- proc~capi_get_version -->
<g id="call~~graph~~CallGraph_node1" class="node">
<title>proc~capi_get_version</title>
<g id="a_call~~graph~~CallGraph_node1"><a xlink:href="../proc/capi_get_version.html" xlink:title="capi_get_version">
<polygon fill="#d94e8f" stroke="#d94e8f" points="92.52,-22.77 0,-22.77 0,0 92.52,0 92.52,-22.77"/>
<text text-anchor="middle" x="46.26" y="-7.04" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">capi_get_version</text>
<polygon fill="#d94e8f" stroke="#d94e8f" points="92.52,-23.52 0,-23.52 0,0 92.52,0 92.52,-23.52"/>
<text text-anchor="middle" x="46.26" y="-7.78" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">capi_get_version</text>
</a>
</g>
</g>
<!-- proc~get_version -->
<g id="call~~graph~~CallGraph_node2" class="node">
<title>proc~get_version</title>
<g id="a_call~~graph~~CallGraph_node2"><a xlink:href="../proc/get_version.html" xlink:title="get_version">
<polygon fill="#d94e8f" stroke="#d94e8f" points="195.54,-22.77 128.52,-22.77 128.52,0 195.54,0 195.54,-22.77"/>
<text text-anchor="middle" x="162.03" y="-7.04" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">get_version</text>
<polygon fill="#d94e8f" stroke="#d94e8f" points="195.54,-23.52 128.52,-23.52 128.52,0 195.54,0 195.54,-23.52"/>
<text text-anchor="middle" x="162.03" y="-7.78" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">get_version</text>
</a>
</g>
</g>
<!-- proc~capi_get_version&#45;&gt;proc~get_version -->
<g id="call~~graph~~CallGraph_edge1" class="edge">
<title>proc~capi_get_version&#45;&gt;proc~get_version</title>
<path fill="none" stroke="#ff0000" d="M92.88,-11.39C100.85,-11.39 109.14,-11.39 117.07,-11.39"/>
<polygon fill="#ff0000" stroke="#ff0000" points="116.84,-14.89 126.84,-11.39 116.84,-7.89 116.84,-14.89"/>
<path fill="none" stroke="#ff0000" d="M92.88,-11.76C100.85,-11.76 109.14,-11.76 117.07,-11.76"/>
<polygon fill="#ff0000" stroke="#ff0000" points="116.84,-15.26 126.84,-11.76 116.84,-8.26 116.84,-15.26"/>
</g>
</g>
</svg>
Expand All @@ -134,55 +134,55 @@ <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 (20240428.1522)
<!-- Generated by graphviz version 11.0.0 (0)
-->
<!-- Title: Graph Key Pages: 1 -->
<svg width="641pt" height="28pt"
viewBox="0.00 0.00 641.00 28.43" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph0" class="graph" transform="scale(0.923937 0.923937) rotate(0) translate(4 26.77)">
<svg width="641pt" height="29pt"
viewBox="0.00 0.00 641.00 29.12" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph0" class="graph" transform="scale(0.923937 0.923937) rotate(0) translate(4 27.52)">
<title>Graph Key</title>
<polygon fill="white" stroke="none" points="-4,4 -4,-26.77 689.77,-26.77 689.77,4 -4,4"/>
<polygon fill="white" stroke="none" points="-4,4 -4,-27.52 689.77,-27.52 689.77,4 -4,4"/>
<!-- Subroutine -->
<g id="node1" class="node">
<title>Subroutine</title>
<polygon fill="#d9534f" stroke="#d9534f" points="63.27,-22.77 0,-22.77 0,0 63.27,0 63.27,-22.77"/>
<text text-anchor="middle" x="31.64" y="-7.04" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">Subroutine</text>
<polygon fill="#d9534f" stroke="#d9534f" points="63.27,-23.52 0,-23.52 0,0 63.27,0 63.27,-23.52"/>
<text text-anchor="middle" x="31.64" y="-7.78" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">Subroutine</text>
</g>
<!-- Function -->
<g id="node2" class="node">
<title>Function</title>
<polygon fill="#d94e8f" stroke="#d94e8f" points="135.63,-22.77 81.64,-22.77 81.64,0 135.63,0 135.63,-22.77"/>
<text text-anchor="middle" x="108.64" y="-7.04" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">Function</text>
<polygon fill="#d94e8f" stroke="#d94e8f" points="135.63,-23.52 81.64,-23.52 81.64,0 135.63,0 135.63,-23.52"/>
<text text-anchor="middle" x="108.64" y="-7.78" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">Function</text>
</g>
<!-- Interface -->
<g id="node3" class="node">
<title>Interface</title>
<polygon fill="#a7506f" stroke="#a7506f" points="207.63,-22.77 153.63,-22.77 153.63,0 207.63,0 207.63,-22.77"/>
<text text-anchor="middle" x="180.63" y="-7.04" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">Interface</text>
<polygon fill="#a7506f" stroke="#a7506f" points="207.63,-23.52 153.63,-23.52 153.63,0 207.63,0 207.63,-23.52"/>
<text text-anchor="middle" x="180.63" y="-7.78" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">Interface</text>
</g>
<!-- Type Bound Procedure -->
<g id="node4" class="node">
<title>Type Bound Procedure</title>
<polygon fill="#a7506f" stroke="#a7506f" points="347.14,-22.77 226.12,-22.77 226.12,0 347.14,0 347.14,-22.77"/>
<text text-anchor="middle" x="286.63" y="-7.04" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">Type Bound Procedure</text>
<polygon fill="#a7506f" stroke="#a7506f" points="347.14,-23.52 226.12,-23.52 226.12,0 347.14,0 347.14,-23.52"/>
<text text-anchor="middle" x="286.63" y="-7.78" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">Type Bound Procedure</text>
</g>
<!-- Unknown Procedure Type -->
<g id="node5" class="node">
<title>Unknown Procedure Type</title>
<polygon fill="#777777" stroke="#777777" points="499.89,-22.77 365.38,-22.77 365.38,0 499.89,0 499.89,-22.77"/>
<text text-anchor="middle" x="432.63" y="-7.04" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">Unknown Procedure Type</text>
<polygon fill="#777777" stroke="#777777" points="499.89,-23.52 365.38,-23.52 365.38,0 499.89,0 499.89,-23.52"/>
<text text-anchor="middle" x="432.63" y="-7.78" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">Unknown Procedure Type</text>
</g>
<!-- Program -->
<g id="node6" class="node">
<title>Program</title>
<polygon fill="#f0ad4e" stroke="#f0ad4e" points="571.63,-22.77 517.63,-22.77 517.63,0 571.63,0 571.63,-22.77"/>
<text text-anchor="middle" x="544.63" y="-7.04" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">Program</text>
<polygon fill="#f0ad4e" stroke="#f0ad4e" points="571.63,-23.52 517.63,-23.52 517.63,0 571.63,0 571.63,-23.52"/>
<text text-anchor="middle" x="544.63" y="-7.78" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">Program</text>
</g>
<!-- This Page&#39;s Entity -->
<g id="node7" class="node">
<title>This Page&#39;s Entity</title>
<polygon fill="none" stroke="black" points="685.77,-22.77 589.5,-22.77 589.5,0 685.77,0 685.77,-22.77"/>
<text text-anchor="middle" x="637.63" y="-7.04" font-family="Helvetica,sans-Serif" font-size="10.50">This Page&#39;s Entity</text>
<polygon fill="none" stroke="black" points="685.77,-23.52 589.5,-23.52 589.5,0 685.77,0 685.77,-23.52"/>
<text text-anchor="middle" x="637.63" y="-7.78" font-family="Helvetica,sans-Serif" font-size="10.50">This Page&#39;s Entity</text>
</g>
</g>
</svg>
Expand Down Expand Up @@ -215,7 +215,7 @@ <h4 class="modal-title" id="-graph-help-label">Graph Key</h4>
<p class="text-end">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2024-06-22T23:27:42.376306 </p>
on 2024-07-04T06:17:33.738233 </p>
</div>
</div>
<br>
Expand Down
40 changes: 20 additions & 20 deletions docs/lists/types.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ <h1>Derived Types</h1>
</thead><tbody>
<tr>
<td><a href='../type/capi_saw_type.html'>capi_saw_type</a></td>
<td><a href='../module/capi__saw_type.html'>capi__saw_type</a></td>
<td><a href='../module/ciaaw__capi_saw_type.html'>ciaaw__capi_saw_type</a></td>
<td>None</td>
<td><p>Derived type representing an element in C.</p></td>
</tr>
Expand All @@ -86,29 +86,29 @@ <h1>Derived Types</h1>
<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 (20240428.1522)
<!-- Generated by graphviz version 11.0.0 (0)
-->
<!-- Title: type~~graph~~TypeGraph Pages: 1 -->
<svg id="typegraphTypeGraph" width="90pt" height="72pt"
viewBox="0.00 0.00 90.02 71.77" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="type~~graph~~TypeGraph" class="graph" transform="scale(1 1) rotate(0) translate(4 67.77)">
<svg id="typegraphTypeGraph" width="90pt" height="74pt"
viewBox="0.00 0.00 90.02 73.52" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="type~~graph~~TypeGraph" class="graph" transform="scale(1 1) rotate(0) translate(4 69.52)">
<title>type~~graph~~TypeGraph</title>
<polygon fill="white" stroke="none" points="-4,4 -4,-67.77 86.02,-67.77 86.02,4 -4,4"/>
<polygon fill="white" stroke="none" points="-4,4 -4,-69.52 86.02,-69.52 86.02,4 -4,4"/>
<!-- type~capi_saw_type -->
<g id="type~~graph~~TypeGraph_node1" class="node">
<title>type~capi_saw_type</title>
<g id="a_type~~graph~~TypeGraph_node1"><a xlink:href="../type/capi_saw_type.html" xlink:title="capi_saw_type">
<polygon fill="#5cb85c" stroke="#5cb85c" points="82.02,-22.77 0,-22.77 0,0 82.02,0 82.02,-22.77"/>
<text text-anchor="middle" x="41.01" y="-7.04" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">capi_saw_type</text>
<polygon fill="#5cb85c" stroke="#5cb85c" points="82.02,-23.52 0,-23.52 0,0 82.02,0 82.02,-23.52"/>
<text text-anchor="middle" x="41.01" y="-7.78" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">capi_saw_type</text>
</a>
</g>
</g>
<!-- type~saw_type -->
<g id="type~~graph~~TypeGraph_node2" class="node">
<title>type~saw_type</title>
<g id="a_type~~graph~~TypeGraph_node2"><a xlink:href="../type/saw_type.html" xlink:title="saw_type">
<polygon fill="#5cb85c" stroke="#5cb85c" points="69.27,-63.77 12.75,-63.77 12.75,-41 69.27,-41 69.27,-63.77"/>
<text text-anchor="middle" x="41.01" y="-48.04" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">saw_type</text>
<polygon fill="#5cb85c" stroke="#5cb85c" points="69.27,-65.52 12.75,-65.52 12.75,-42 69.27,-42 69.27,-65.52"/>
<text text-anchor="middle" x="41.01" y="-49.78" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">saw_type</text>
</a>
</g>
</g>
Expand All @@ -129,25 +129,25 @@ <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 (20240428.1522)
<!-- Generated by graphviz version 11.0.0 (0)
-->
<!-- Title: Graph Key Pages: 1 -->
<svg width="176pt" height="31pt"
viewBox="0.00 0.00 176.13 30.77" 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 26.77)">
<svg width="176pt" height="32pt"
viewBox="0.00 0.00 176.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)">
<title>Graph Key</title>
<polygon fill="white" stroke="none" points="-4,4 -4,-26.77 172.13,-26.77 172.13,4 -4,4"/>
<polygon fill="white" stroke="none" points="-4,4 -4,-27.52 172.13,-27.52 172.13,4 -4,4"/>
<!-- Type -->
<g id="node1" class="node">
<title>Type</title>
<polygon fill="#5cb85c" stroke="#5cb85c" points="54,-22.77 0,-22.77 0,0 54,0 54,-22.77"/>
<text text-anchor="middle" x="27" y="-7.04" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">Type</text>
<polygon fill="#5cb85c" stroke="#5cb85c" 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">Type</text>
</g>
<!-- This Page&#39;s Entity -->
<g id="node2" class="node">
<title>This Page&#39;s Entity</title>
<polygon fill="none" stroke="black" points="168.13,-22.77 71.87,-22.77 71.87,0 168.13,0 168.13,-22.77"/>
<text text-anchor="middle" x="120" y="-7.04" font-family="Helvetica,sans-Serif" font-size="10.50">This Page&#39;s Entity</text>
<polygon fill="none" stroke="black" points="168.13,-23.52 71.87,-23.52 71.87,0 168.13,0 168.13,-23.52"/>
<text text-anchor="middle" x="120" y="-7.78" font-family="Helvetica,sans-Serif" font-size="10.50">This Page&#39;s Entity</text>
</g>
</g>
</svg>
Expand Down Expand Up @@ -180,7 +180,7 @@ <h4 class="modal-title" id="-graph-help-label">Graph Key</h4>
<p class="text-end">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2024-06-22T23:27:42.376306 </p>
on 2024-07-04T06:17:33.738233 </p>
</div>
</div>
<br>
Expand Down
Binary file modified docs/media/logo.ico
View file
Binary file not shown.
Binary file modified docs/media/logo.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/media/src/logo.tex
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
\usepackage{tikz}
\usepackage{circuitikz}
\usepackage{amsmath}
%\usepackage[exscale,amsfonts,amssymb]{concmath}
\usepackage[exscale,amsfonts,amssymb]{concmath}
\usepackage{xcolor}
\usepackage{mathastext}
\usepackage{graphicx}
Expand Down
Loading

0 comments on commit d85bc04

Please sign in to comment.