Skip to content

Commit

Permalink
Update online doc.
Browse files Browse the repository at this point in the history
  • Loading branch information
@MilanSkocic
MilanSkocic committed Nov 21, 2024
1 parent 1ccd935 commit f53a1b0
Show file tree
Hide file tree
Showing 65 changed files with 1,257 additions and 86,044 deletions.
23 changes: 13 additions & 10 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,9 +92,7 @@ <h1 id="introduction">Introduction</h1>
<p><code>codata</code> is a Fortran library providing the latest codata constants (2022) and
older values (2018, 2014 and 2010).
The raw codata are taken from http://physics.nist.gov/constants.
The constants (values and uncertainties) are implemented as double precision reals.
C API allows usage from C, or can be used as a basis for other wrappers.
Python wrapper allows easy usage from Python.</p>
The constants (values and uncertainties) are implemented as double precision reals.</p>
<p>The names are quite long and can be aliased with shorter names.</p>
<p>To use <code>codata</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>
Expand All @@ -111,10 +109,15 @@ <h1 id="introduction">Introduction</h1>
<p>If you only need sources for the codata constants that you can integrate directly in your sources you may be interested by https://github.com/vmagnin/fundamental_constants. </p>
</li>
</ul>
<p><strong>Extra:</strong></p>
<ul>
<li>Pure python code is provided in the <code>py</code> folder. See <code>py/README.md</code>.</li>
<li>Pure C code is provided in the <code>C</code> folder. See <code>C/README.md</code></li>
</ul>
<h1 id="dependencies">Dependencies</h1>
<div class="codehilite"><pre><span></span><code>gcc&gt;=10
gfortran&gt;=10
<div class="codehilite"><pre><span></span><code>gfortran&gt;=10
fpm&gt;=0.7
stdlib&gt;=0.5
fypp&gt;=3.0
</code></pre></div>

Expand Down Expand Up @@ -170,7 +173,7 @@ <h4 class="card-text">Milan Skocic</h4>
<div class="col-xs-6 col-sm-3">
<div>
<h3>Source Files</h3>
<ul><li><a href='sourcefile/capi.f90.html'>capi.f90</a></li><li><a href='sourcefile/capi_constants.f90.html'>capi_constants.f90</a></li><li><a href='sourcefile/capi_constants_2010.f90.html'>capi_constants_2010.f90</a></li><li><a href='sourcefile/capi_constants_2014.f90.html'>capi_constants_2014.f90</a></li><li><a href='sourcefile/capi_constants_2018.f90.html'>capi_constants_2018.f90</a></li><li><a href='sourcefile/capi_constants_2022.f90.html'>capi_constants_2022.f90</a></li><li><a href='sourcefile/capi_constants_type.f90.html'>capi_constants_type.f90</a></li><li><a href='sourcefile/capi_version.f90.html'>capi_version.f90</a></li><li><a href='sourcefile/codata.f90.html'>codata.f90</a></li><li><a href='sourcefile/codata_constants.f90.html'>codata_constants.f90</a></li></ul>
<ul><li><a href='sourcefile/codata.f90.html'>codata.f90</a></li><li><a href='sourcefile/codata_constants.f90.html'>codata_constants.f90</a></li><li><a href='sourcefile/codata_constants_2010.f90.html'>codata_constants_2010.f90</a></li><li><a href='sourcefile/codata_constants_2014.f90.html'>codata_constants_2014.f90</a></li><li><a href='sourcefile/codata_constants_2018.f90.html'>codata_constants_2018.f90</a></li><li><a href='sourcefile/codata_constants_2022.f90.html'>codata_constants_2022.f90</a></li><li><a href='sourcefile/codata_constants_type.f90.html'>codata_constants_type.f90</a></li><li><a href='sourcefile/codata_constants_type.fypp.html'>codata_constants_type.fypp</a></li><li><a href='sourcefile/codata_version.f90.html'>codata_version.f90</a></li></ul>
</div>
<div>
<ul>
Expand All @@ -181,7 +184,7 @@ <h3>Source Files</h3>
<div class="col-xs-6 col-sm-3">
<div>
<h3>Modules</h3>
<ul><li><a href='module/codata.html'>codata</a></li><li><a href='module/codata__capi.html'>codata__capi</a></li><li><a href='module/codata__capi_constants.html'>codata__capi_constants</a></li><li><a href='module/codata__capi_constants_2010.html'>codata__capi_constants_2010</a></li><li><a href='module/codata__capi_constants_2014.html'>codata__capi_constants_2014</a></li><li><a href='module/codata__capi_constants_2018.html'>codata__capi_constants_2018</a></li><li><a href='module/codata__capi_constants_2022.html'>codata__capi_constants_2022</a></li><li><a href='module/codata__capi_constants_type.html'>codata__capi_constants_type</a></li><li><a href='module/codata__capi_version.html'>codata__capi_version</a></li><li><a href='module/codata__constants.html'>codata__constants</a></li></ul>
<ul><li><a href='module/codata.html'>codata</a></li><li><a href='module/codata__constants.html'>codata__constants</a></li><li><a href='module/codata__constants_2010.html'>codata__constants_2010</a></li><li><a href='module/codata__constants_2014.html'>codata__constants_2014</a></li><li><a href='module/codata__constants_2018.html'>codata__constants_2018</a></li><li><a href='module/codata__constants_2022.html'>codata__constants_2022</a></li><li><a href='module/codata__constants_type~2.html'>codata__constants_type</a></li><li><a href='module/codata__constants_type.html'>codata__constants_type</a></li><li><a href='module/codata__version.html'>codata__version</a></li></ul>
</div>
<div>
<ul>
Expand All @@ -192,7 +195,7 @@ <h3>Modules</h3>
<div class="col-xs-6 col-sm-3">
<div>
<h3>Procedures</h3>
<ul><li><a href='proc/capi_get_version.html'>capi_get_version</a></li><li><a href='proc/get_version.html'>get_version</a></li><li><a href='interface/to_real.html'>to_real</a></li><li><a href='interface/to_real~2.html'>to_real</a></li></ul>
<ul><li><a href='proc/get_version.html'>get_version</a></li><li><a href='interface/to_real.html'>to_real</a></li><li><a href='interface/to_real~2.html'>to_real</a></li></ul>
</div>
<div>
<ul>
Expand All @@ -203,7 +206,7 @@ <h3>Procedures</h3>
<div class="col-xs-6 col-sm-3">
<div>
<h3>Derived Types</h3>
<ul><li><a href='type/capi_constant_type.html'>capi_constant_type</a></li><li><a href='type/codata_constant_type.html'>codata_constant_type</a></li><li><a href='type/codata_constant_type~2.html'>codata_constant_type</a></li></ul>
<ul><li><a href='type/codata_constant_type.html'>codata_constant_type</a></li><li><a href='type/codata_constant_type~2.html'>codata_constant_type</a></li></ul>
</div>
<div>
<ul>
Expand All @@ -227,7 +230,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-07-17T00:40:25.670218 </p>
on 2024-11-21T21:18:40.795351 </p>
</div>
</div>
<br>
Expand Down
6 changes: 3 additions & 3 deletions docs/interface/to_real.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ <h1>to_real

<li class="list-inline-item" id="statements"><i class="fa fa-list-ol"></i>
<a data-bs-toggle="tooltip" data-bs-placement="bottom" data-bs-html="true"
title="<p>13.3% of total for procedures.</p>Including implementation: 28 statements, 93.3% of total for procedures.">4 statements</a>
title="<p>22.2% of total for procedures.</p>Including implementation: 28 statements, 155.6% of total for procedures.">4 statements</a>
</li>

<li class="list-inline-item" id="source-file">
Expand All @@ -88,7 +88,7 @@ <h1>to_real
<nav aria-label="breadcrumb">
<ol class="breadcrumb justify-content-end mb-0">
<li class="breadcrumb-item"><a href='../sourcefile/codata_constants_type.fypp.html'>codata_constants_type.fypp</a></li>
<li class="breadcrumb-item"><a href='../module/codata__constants_type.html'>codata__constants_type</a></li>
<li class="breadcrumb-item"><a href='../module/codata__constants_type~2.html'>codata__constants_type</a></li>
<li class="breadcrumb-item active" aria-current="page">to_real</li>
</ol>
</nav>
Expand Down Expand Up @@ -317,7 +317,7 @@ <h4>
<p class="text-end">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2024-07-17T00:40:25.670218 </p>
on 2024-11-21T21:18:40.795351 </p>
</div>
</div>
<br>
Expand Down
6 changes: 3 additions & 3 deletions docs/interface/to_real~2.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ <h1>to_real

<li class="list-inline-item" id="statements"><i class="fa fa-list-ol"></i>
<a data-bs-toggle="tooltip" data-bs-placement="bottom" data-bs-html="true"
title="<p>13.3% of total for procedures.</p>Including implementation: 28 statements, 93.3% of total for procedures.">4 statements</a>
title="<p>22.2% of total for procedures.</p>Including implementation: 28 statements, 155.6% of total for procedures.">4 statements</a>
</li>

<li class="list-inline-item" id="source-file">
Expand All @@ -88,7 +88,7 @@ <h1>to_real
<nav aria-label="breadcrumb">
<ol class="breadcrumb justify-content-end mb-0">
<li class="breadcrumb-item"><a href='../sourcefile/codata_constants_type.f90.html'>codata_constants_type.f90</a></li>
<li class="breadcrumb-item"><a href='../module/codata__constants_type~2.html'>codata__constants_type</a></li>
<li class="breadcrumb-item"><a href='../module/codata__constants_type.html'>codata__constants_type</a></li>
<li class="breadcrumb-item active" aria-current="page">to_real</li>
</ol>
</nav>
Expand Down Expand Up @@ -317,7 +317,7 @@ <h4>
<p class="text-end">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2024-07-17T00:40:25.670218 </p>
on 2024-11-21T21:18:40.795351 </p>
</div>
</div>
<br>
Expand Down
Loading

0 comments on commit f53a1b0

Please sign in to comment.