Skip to content

Commit

Permalink
DOC: Update online documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
@MilanSkocic
MilanSkocic committed Jun 18, 2024
1 parent 3948851 commit f4fdd56
Show file tree
Hide file tree
Showing 57 changed files with 875 additions and 882 deletions.
8 changes: 2 additions & 6 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
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.

The names are quite long and can be aliased with shorter names.

Expand All @@ -15,12 +17,6 @@ add the following to your `fpm.toml` file:
codata = { git="https://github.com/MilanSkocic/codata.git" }
```

Optional thin wrappers allow usage of the library from other languages, e.g.:

* [C wrapper](https://github.com/MilanSkocic/codata-capi)
* [Python wrapper](https://github.com/MilanSkocic/codata-py)


**Notes**:

* The latest codata constants were integrated in the [stdlib](https://github.com/fortran-lang/stdlib/pull/800). The constants are implemented as derived type which carries the name, the value, the uncertainty and the unit. This library will be complementary to the constants defined in the stdlib by providing older values for the constants.
Expand Down
11 changes: 4 additions & 7 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,19 +92,16 @@ <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.</p>
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>
<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>
<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">codata</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/codata.git&quot;</span><span class="w"> </span><span class="err">}</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/codata-capi">C wrapper</a></li>
<li><a href="https://github.com/MilanSkocic/codata-py">Python wrapper</a></li>
</ul>
<p><strong>Notes</strong>: </p>
<ul>
<li>
Expand Down Expand Up @@ -230,7 +227,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-18T10:23:47.036270 </p>
on 2024-06-18T10:37:17.441713 </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 @@ -80,14 +80,14 @@ <h1>to_real

<li class="list-inline-item" id="source-file">
<i class="fa fa-code"></i>
<a href="../src/codata_constants_type.fypp"> Source File</a>
<a href="../src/codata_constants_type.f90"> Source File</a>
</li>
</ul>
</div>
<div class="col">
<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='../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 active" aria-current="page">to_real</li>
</ol>
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-06-18T10:23:47.036270 </p>
on 2024-06-18T10:37:17.441713 </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 @@ -80,14 +80,14 @@ <h1>to_real

<li class="list-inline-item" id="source-file">
<i class="fa fa-code"></i>
<a href="../src/codata_constants_type.f90"> Source File</a>
<a href="../src/codata_constants_type.fypp"> Source File</a>
</li>
</ul>
</div>
<div class="col">
<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='../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 active" aria-current="page">to_real</li>
</ol>
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-06-18T10:23:47.036270 </p>
on 2024-06-18T10:37:17.441713 </p>
</div>
</div>
<br>
Expand Down
48 changes: 24 additions & 24 deletions docs/lists/files.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -406,50 +406,50 @@ <h1>Source Files</h1>
<g id="file~~graph~~FileGraph_node15" class="node">
<title>sourcefile~codata_constants_type.f90</title>
<g id="a_file~~graph~~FileGraph_node15"><a xlink:href="../sourcefile/codata_constants_type.f90.html" xlink:title="codata_constants_type.f90">
<polygon fill="#f0ad4e" stroke="#f0ad4e" points="876,-129.94 722,-129.94 722,-105.94 876,-105.94 876,-129.94"/>
<text text-anchor="middle" x="799" y="-115.54" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">codata_constants_type.f90</text>
<polygon fill="#f0ad4e" stroke="#f0ad4e" points="876,-87.94 722,-87.94 722,-63.94 876,-63.94 876,-87.94"/>
<text text-anchor="middle" x="799" y="-73.54" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">codata_constants_type.f90</text>
</a>
</g>
</g>
<!-- sourcefile~codata_constants_type.fypp -->
<g id="file~~graph~~FileGraph_node16" class="node">
<title>sourcefile~codata_constants_type.fypp</title>
<g id="a_file~~graph~~FileGraph_node16"><a xlink:href="../sourcefile/codata_constants_type.fypp.html" xlink:title="codata_constants_type.fypp">
<polygon fill="#f0ad4e" stroke="#f0ad4e" points="879,-87.94 719,-87.94 719,-63.94 879,-63.94 879,-87.94"/>
<text text-anchor="middle" x="799" y="-73.54" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">codata_constants_type.fypp</text>
</a>
</g>
</g>
<!-- sourcefile~codata_constants_type.fypp&#45;&gt;sourcefile~codata_constants.f90 -->
<!-- sourcefile~codata_constants_type.f90&#45;&gt;sourcefile~codata_constants.f90 -->
<g id="file~~graph~~FileGraph_edge24" class="edge">
<title>sourcefile~codata_constants_type.fypp&#45;&gt;sourcefile~codata_constants.f90</title>
<title>sourcefile~codata_constants_type.f90&#45;&gt;sourcefile~codata_constants.f90</title>
<path fill="none" stroke="#00d1ff" d="M781.97,-63.71C760.71,-48.34 721.37,-22.76 683,-12.94 619.35,3.35 544.26,1.16 490.29,-3.97"/>
<polygon fill="#00d1ff" stroke="#00d1ff" points="489.73,-0.51 480.13,-4.99 490.43,-7.47 489.73,-0.51"/>
</g>
<!-- sourcefile~codata_constants_type.fypp&#45;&gt;sourcefile~codata_constants_2010.f90 -->
<!-- sourcefile~codata_constants_type.f90&#45;&gt;sourcefile~codata_constants_2010.f90 -->
<g id="file~~graph~~FileGraph_edge25" class="edge">
<title>sourcefile~codata_constants_type.fypp&#45;&gt;sourcefile~codata_constants_2010.f90</title>
<path fill="none" stroke="#0078ff" d="M718.94,-75.94C710.58,-75.94 702.04,-75.94 693.57,-75.94"/>
<polygon fill="#0078ff" stroke="#0078ff" points="693.31,-72.44 683.31,-75.94 693.31,-79.44 693.31,-72.44"/>
<title>sourcefile~codata_constants_type.f90&#45;&gt;sourcefile~codata_constants_2010.f90</title>
<path fill="none" stroke="#0078ff" d="M722,-75.94C712.62,-75.94 702.98,-75.94 693.44,-75.94"/>
<polygon fill="#0078ff" stroke="#0078ff" points="693.15,-72.44 683.15,-75.94 693.15,-79.44 693.15,-72.44"/>
</g>
<!-- sourcefile~codata_constants_type.fypp&#45;&gt;sourcefile~codata_constants_2014.f90 -->
<!-- sourcefile~codata_constants_type.f90&#45;&gt;sourcefile~codata_constants_2014.f90 -->
<g id="file~~graph~~FileGraph_edge26" class="edge">
<title>sourcefile~codata_constants_type.fypp&#45;&gt;sourcefile~codata_constants_2014.f90</title>
<title>sourcefile~codata_constants_type.f90&#45;&gt;sourcefile~codata_constants_2014.f90</title>
<path fill="none" stroke="#001dff" d="M742.69,-63.9C720.08,-58.98 693.76,-53.25 670.21,-48.13"/>
<polygon fill="#001dff" stroke="#001dff" points="670.83,-44.68 660.31,-45.98 669.34,-51.52 670.83,-44.68"/>
</g>
<!-- sourcefile~codata_constants_type.fypp&#45;&gt;sourcefile~codata_constants_2018.f90 -->
<!-- sourcefile~codata_constants_type.f90&#45;&gt;sourcefile~codata_constants_2018.f90 -->
<g id="file~~graph~~FileGraph_edge27" class="edge">
<title>sourcefile~codata_constants_type.fypp&#45;&gt;sourcefile~codata_constants_2018.f90</title>
<title>sourcefile~codata_constants_type.f90&#45;&gt;sourcefile~codata_constants_2018.f90</title>
<path fill="none" stroke="#3c00ff" d="M737.3,-87.98C730.88,-90.44 724.65,-93.39 719,-96.94 698.18,-110.02 703.8,-125.83 683,-138.94 680.21,-140.7 677.28,-142.31 674.25,-143.79"/>
<polygon fill="#3c00ff" stroke="#3c00ff" points="672.71,-140.64 664.93,-147.83 675.5,-147.06 672.71,-140.64"/>
</g>
<!-- sourcefile~codata_constants_type.fypp&#45;&gt;sourcefile~codata_constants_2022.f90 -->
<!-- sourcefile~codata_constants_type.f90&#45;&gt;sourcefile~codata_constants_2022.f90 -->
<g id="file~~graph~~FileGraph_edge28" class="edge">
<title>sourcefile~codata_constants_type.fypp&#45;&gt;sourcefile~codata_constants_2022.f90</title>
<title>sourcefile~codata_constants_type.f90&#45;&gt;sourcefile~codata_constants_2022.f90</title>
<path fill="none" stroke="#9500ff" d="M742.69,-87.98C720.08,-92.9 693.76,-98.63 670.21,-103.75"/>
<polygon fill="#9500ff" stroke="#9500ff" points="669.34,-100.36 660.31,-105.9 670.83,-107.2 669.34,-100.36"/>
</g>
<!-- sourcefile~codata_constants_type.fypp -->
<g id="file~~graph~~FileGraph_node16" class="node">
<title>sourcefile~codata_constants_type.fypp</title>
<g id="a_file~~graph~~FileGraph_node16"><a xlink:href="../sourcefile/codata_constants_type.fypp.html" xlink:title="codata_constants_type.fypp">
<polygon fill="#f0ad4e" stroke="#f0ad4e" points="879,-129.94 719,-129.94 719,-105.94 879,-105.94 879,-129.94"/>
<text text-anchor="middle" x="799" y="-115.54" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">codata_constants_type.fypp</text>
</a>
</g>
</g>
<!-- sourcefile~codata_version.f90 -->
<g id="file~~graph~~FileGraph_node17" class="node">
<title>sourcefile~codata_version.f90</title>
Expand Down Expand Up @@ -541,7 +541,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-18T10:23:47.036270 </p>
on 2024-06-18T10:37:17.441713 </p>
</div>
</div>
<br>
Expand Down
6 changes: 3 additions & 3 deletions docs/lists/modules.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -145,12 +145,12 @@ <h1>Modules</h1>
</tr>
<!----> <tr class="active">
<td><a href='../module/codata__constants_type~2.html'>codata__constants_type</a></td>
<td><a href='../sourcefile/codata_constants_type.fypp.html'>codata_constants_type.fypp</a></td>
<td><a href='../sourcefile/codata_constants_type.f90.html'>codata_constants_type.f90</a></td>
<td><p>Codata constant type</p></td>
</tr>
<!--active--> <tr class="">
<td><a href='../module/codata__constants_type.html'>codata__constants_type</a></td>
<td><a href='../sourcefile/codata_constants_type.f90.html'>codata_constants_type.f90</a></td>
<td><a href='../sourcefile/codata_constants_type.fypp.html'>codata_constants_type.fypp</a></td>
<td><p>Codata constant type</p></td>
</tr>
<!----> <tr class="active">
Expand Down Expand Up @@ -733,7 +733,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-18T10:23:47.036270 </p>
on 2024-06-18T10:37:17.441713 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion docs/lists/procedures.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -323,7 +323,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-18T10:23:47.036270 </p>
on 2024-06-18T10:37:17.441713 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion docs/lists/types.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,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-18T10:23:47.036270 </p>
on 2024-06-18T10:37:17.441713 </p>
</div>
</div>
<br>
Expand Down
4 changes: 2 additions & 2 deletions docs/module/capi.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -141,8 +141,8 @@ <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='capi__constants.html'>capi__constants</a></li>
<li class="list-inline-item"><a href='capi__version.html'>capi__version</a></li>
<li class="list-inline-item"><a href='capi__constants.html'>capi__constants</a></li>
</ul>
</li>
<li class="list-group-item">
Expand Down Expand Up @@ -751,7 +751,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-18T10:23:47.036270 </p>
on 2024-06-18T10:37:17.441713 </p>
</div>
</div>
<br>
Expand Down
8 changes: 4 additions & 4 deletions docs/module/capi__constants.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -143,11 +143,11 @@ <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='capi__constants_2014.html'>capi__constants_2014</a></li>
<li class="list-inline-item"><a href='capi__constants_2010.html'>capi__constants_2010</a></li>
<li class="list-inline-item"><a href='capi__constants_2022.html'>capi__constants_2022</a></li>
<li class="list-inline-item"><a href='capi__constants_type.html'>capi__constants_type</a></li>
<li class="list-inline-item"><a href='capi__constants_2014.html'>capi__constants_2014</a></li>
<li class="list-inline-item"><a href='capi__constants_2018.html'>capi__constants_2018</a></li>
<li class="list-inline-item"><a href='capi__constants_2022.html'>capi__constants_2022</a></li>
<li class="list-inline-item"><a href='capi__constants_2010.html'>capi__constants_2010</a></li>
</ul>
</li>
<li class="list-group-item">
Expand Down Expand Up @@ -706,7 +706,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-18T10:23:47.036270 </p>
on 2024-06-18T10:37:17.441713 </p>
</div>
</div>
<br>
Expand Down
4 changes: 2 additions & 2 deletions docs/module/capi__constants_2010.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -487,8 +487,8 @@ <h3 class="card-header card-title bg-light">Uses</h3>
<li class="list-group-item">
<ul class="list-inline">
<li class="list-inline-item"><a href='http://fortranwiki.org/fortran/show/iso_c_binding'>iso_c_binding</a></li>
<li class="list-inline-item"><a href='capi__constants_type.html'>capi__constants_type</a></li>
<li class="list-inline-item"><a href='codata__constants_2010.html'>codata__constants_2010</a></li>
<li class="list-inline-item"><a href='capi__constants_type.html'>capi__constants_type</a></li>
</ul>
</li>
<li class="list-group-item">
Expand Down Expand Up @@ -6608,7 +6608,7 @@ <h2>Variables</h2>
<p class="text-end">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2024-06-18T10:23:47.036270 </p>
on 2024-06-18T10:37:17.441713 </p>
</div>
</div>
<br>
Expand Down
4 changes: 2 additions & 2 deletions docs/module/capi__constants_2014.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -487,8 +487,8 @@ <h3 class="card-header card-title bg-light">Uses</h3>
<li class="list-group-item">
<ul class="list-inline">
<li class="list-inline-item"><a href='http://fortranwiki.org/fortran/show/iso_c_binding'>iso_c_binding</a></li>
<li class="list-inline-item"><a href='capi__constants_type.html'>capi__constants_type</a></li>
<li class="list-inline-item"><a href='codata__constants_2014.html'>codata__constants_2014</a></li>
<li class="list-inline-item"><a href='capi__constants_type.html'>capi__constants_type</a></li>
</ul>
</li>
<li class="list-group-item">
Expand Down Expand Up @@ -6608,7 +6608,7 @@ <h2>Variables</h2>
<p class="text-end">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2024-06-18T10:23:47.036270 </p>
on 2024-06-18T10:37:17.441713 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion docs/module/capi__constants_2018.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6950,7 +6950,7 @@ <h2>Variables</h2>
<p class="text-end">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2024-06-18T10:23:47.036270 </p>
on 2024-06-18T10:37:17.441713 </p>
</div>
</div>
<br>
Expand Down
4 changes: 2 additions & 2 deletions docs/module/capi__constants_2022.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -507,8 +507,8 @@ <h3 class="card-header card-title bg-light">Uses</h3>
<li class="list-group-item">
<ul class="list-inline">
<li class="list-inline-item"><a href='http://fortranwiki.org/fortran/show/iso_c_binding'>iso_c_binding</a></li>
<li class="list-inline-item"><a href='capi__constants_type.html'>capi__constants_type</a></li>
<li class="list-inline-item"><a href='codata__constants_2022.html'>codata__constants_2022</a></li>
<li class="list-inline-item"><a href='capi__constants_type.html'>capi__constants_type</a></li>
</ul>
</li>
<li class="list-group-item">
Expand Down Expand Up @@ -6968,7 +6968,7 @@ <h2>Variables</h2>
<p class="text-end">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2024-06-18T10:23:47.036270 </p>
on 2024-06-18T10:37:17.441713 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion docs/module/capi__constants_type.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -630,7 +630,7 @@ <h4>Components</h4>
<p class="text-end">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2024-06-18T10:23:47.036270 </p>
on 2024-06-18T10:37:17.441713 </p>
</div>
</div>
<br>
Expand Down
Loading

0 comments on commit f4fdd56

Please sign in to comment.