Skip to content

Commit

Permalink
DOC: Online documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
mskocic committed Jun 19, 2023
1 parent 308f8f7 commit 47b2f21
Show file tree
Hide file tree
Showing 26 changed files with 29 additions and 38 deletions.
Binary file modified docs/_downloads/c6590f1cb16fa3c0fab9a03d320b9284/iapws.pdf
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/ford/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,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-06-19T06:36:53.416960 </p>
on 2023-06-19T14:11:24.965019 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion docs/ford/lists/files.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,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-06-19T06:36:53.416960 </p>
on 2023-06-19T14:11:24.965019 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion docs/ford/lists/modules.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ <h1>Modules</h1>
<p class="text-right">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2023-06-19T06:36:53.416960 </p>
on 2023-06-19T14:11:24.965019 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion docs/ford/lists/procedures.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ <h1>Procedures</h1>
<p class="text-right">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2023-06-19T06:36:53.416960 </p>
on 2023-06-19T14:11:24.965019 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion docs/ford/lists/types.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ <h1>Derived Types</h1>
<p class="text-right">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2023-06-19T06:36:53.416960 </p>
on 2023-06-19T14:11:24.965019 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion docs/ford/module/iapws.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ <h3>Contents</h3>
<p class="text-right">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2023-06-19T06:36:53.416960 </p>
on 2023-06-19T14:11:24.965019 </p>
</div>
</div>
<br>
Expand Down
4 changes: 2 additions & 2 deletions docs/ford/module/iapws_g704.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -188,8 +188,8 @@ <h3 class="panel-title">Uses</h3>
<ul class="list-group">
<li class="list-group-item">
<ul class="list-inline">
<li><a href="http://fortranwiki.org/fortran/show/iso_fortran_env">iso_fortran_env</a></li>
<li><a href="http://fortranwiki.org/fortran/show/ieee_arithmetic">ieee_arithmetic</a></li>
<li><a href="http://fortranwiki.org/fortran/show/iso_fortran_env">iso_fortran_env</a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -655,7 +655,7 @@ <h4>Arguments</h4>
<p class="text-right">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2023-06-19T06:36:53.416960 </p>
on 2023-06-19T14:11:24.965019 </p>
</div>
</div>
<br>
Expand Down
6 changes: 3 additions & 3 deletions docs/ford/module/iapws_g704_capi.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -175,9 +175,9 @@ <h3 class="panel-title">Uses</h3>
<ul class="list-group">
<li class="list-group-item">
<ul class="list-inline">
<li><a href="http://fortranwiki.org/fortran/show/iso_fortran_env">iso_fortran_env</a></li>
<li><a href='../module/iapws_g704.html'>iapws_g704</a></li>
<li><a href="http://fortranwiki.org/fortran/show/iso_c_binding">iso_c_binding</a></li>
<li><a href='../module/iapws_g704.html'>iapws_g704</a></li>
<li><a href="http://fortranwiki.org/fortran/show/iso_fortran_env">iso_fortran_env</a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -592,7 +592,7 @@ <h4>Arguments</h4>
<p class="text-right">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2023-06-19T06:36:53.416960 </p>
on 2023-06-19T14:11:24.965019 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion docs/ford/proc/iapws_g704_capi_gases.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ <h3>Contents</h3>
<p class="text-right">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2023-06-19T06:36:53.416960 </p>
on 2023-06-19T14:11:24.965019 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion docs/ford/proc/iapws_g704_capi_kd.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -305,7 +305,7 @@ <h3>Contents</h3>
<p class="text-right">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2023-06-19T06:36:53.416960 </p>
on 2023-06-19T14:11:24.965019 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion docs/ford/proc/iapws_g704_capi_kh.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -305,7 +305,7 @@ <h3>Contents</h3>
<p class="text-right">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2023-06-19T06:36:53.416960 </p>
on 2023-06-19T14:11:24.965019 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion docs/ford/proc/iapws_g704_capi_ngases.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ <h3>Contents</h3>
<p class="text-right">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2023-06-19T06:36:53.416960 </p>
on 2023-06-19T14:11:24.965019 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion docs/ford/proc/iapws_g704_gases.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ <h3>Contents</h3>
<p class="text-right">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2023-06-19T06:36:53.416960 </p>
on 2023-06-19T14:11:24.965019 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion docs/ford/proc/iapws_g704_gases2.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ <h3>Contents</h3>
<p class="text-right">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2023-06-19T06:36:53.416960 </p>
on 2023-06-19T14:11:24.965019 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion docs/ford/proc/iapws_g704_kd.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,7 @@ <h3>Contents</h3>
<p class="text-right">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2023-06-19T06:36:53.416960 </p>
on 2023-06-19T14:11:24.965019 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion docs/ford/proc/iapws_g704_kh.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,7 @@ <h3>Contents</h3>
<p class="text-right">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2023-06-19T06:36:53.416960 </p>
on 2023-06-19T14:11:24.965019 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion docs/ford/proc/iapws_g704_ngases.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ <h3>Contents</h3>
<p class="text-right">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2023-06-19T06:36:53.416960 </p>
on 2023-06-19T14:11:24.965019 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion docs/ford/search.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ <h1>Search Results</h1>
<p class="text-right">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2023-06-19T06:36:53.416960 </p>
on 2023-06-19T14:11:24.965019 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion docs/ford/sourcefile/iapws.f90.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ <h2><span class="anchor" id="src"></span>Source Code</h2>
<p class="text-right">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2023-06-19T06:36:53.416960 </p>
on 2023-06-19T14:11:24.965019 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion docs/ford/sourcefile/iapws_g704.f90.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -726,7 +726,7 @@ <h2><span class="anchor" id="src"></span>Source Code</h2>
<p class="text-right">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2023-06-19T06:36:53.416960 </p>
on 2023-06-19T14:11:24.965019 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion docs/ford/sourcefile/iapws_g704_capi.f90.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -399,7 +399,7 @@ <h2><span class="anchor" id="src"></span>Source Code</h2>
<p class="text-right">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2023-06-19T06:36:53.416960 </p>
on 2023-06-19T14:11:24.965019 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion docs/ford/tipuesearch/tipuesearch_content.js
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/ford/type/iapws_g704_gas_t.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@ <h2>Components</h2>
<p class="text-right">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2023-06-19T06:36:53.416960 </p>
on 2023-06-19T14:11:24.965019 </p>
</div>
</div>
<br>
Expand Down
13 changes: 2 additions & 11 deletions docs/getting_started/iapws.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,17 +51,8 @@ <h1>iapw<a class="headerlink" href="#iapw" title="Permalink to this heading">¶<
It also provides a API for the C language. The formulas are taken from <a class="reference external" href="http://iapws.org">http://iapws.org</a>.</p>
<section id="how-to-install">
<h2>How to install<a class="headerlink" href="#how-to-install" title="Permalink to this heading"></a></h2>
<p>A Makefile is provided which uses <a class="reference external" href="https://fpm.fortran-lang.org/en/index.html">fpm</a> for building the library
with additional options:</p>
<ul class="simple">
<li><p>compile the source generator and generate the sources</p></li>
<li><p>copy needed sources into the python wrapper folder</p></li>
<li><p>build a shared library</p></li>
<li><p>install the C headers</p></li>
<li><p>uninstall the library and headers</p></li>
</ul>
<p>On windows, <a class="reference external" href="https://www.msys2.org">msys2</a> needs to be installed and use
the mingw64 or mingw32 terminals.</p>
<p>A Makefile is provided, which uses <a class="reference external" href="https://fpm.fortran-lang.org/en/index.html">fpm</a>, for building the library.</p>
<p>On windows, <a class="reference external" href="https://www.msys2.org">msys2</a> needs to be installed.</p>
<p>On Darwin, the <a class="reference external" href="https://formulae.brew.sh/formula/gcc">gcc</a> toolchain needs to be installed.</p>
<p>Build: the configuration file will set all the environmental variables necessary for the compilation</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">source</span> configuration
Expand Down
Loading

0 comments on commit 47b2f21

Please sign in to comment.