Deploying to gh-pages from @ 05d47b2 🚀

README.md

@@ -60,7 +60,7 @@ The demonstration applications
 ### Building and Testing
 Because this repository supports programming language research, the code exercises new language features in novel ways.
 We recommend using any compiler's latest release or even building open-source compilers from source.
-The [handy-dandy] repository contains scripts capturing steps for building the [llvm-project] compiler.
+The [handy-dandy] repository contains scripts capturing steps for building the [LLVM] compiler suite.
 The remainder of this section contains commands for building Inference-Engine with a recent Fortran compiler and the Fortran Package Manager ([`fpm`]) in your `PATH`.
 
 #### GNU (`gfortran`) 13 or higher required
@@ -171,23 +171,24 @@ Documentation
 Please see our [GitHub Pages site] for HTML documentation generated by [`ford`] or generate documentaiton locally by installing `ford` and executing `ford ford.md`.
 
 
+[Building and testing]: #building-and-testing
 [Caffeine]: https://go.lbl.gov/caffeine
 [E3SM]: https://e3sm.org
 [example]: example
 [demo]: demo
+[Documentation]: #documentation
 [example/print-training-configuration.F90]: example/print-training-configuration.F90
-[example/concurrent-inferences]: example/concurrent-inferences
+[example/concurrent-inferences]: example/concurrent-inferences.f90
 [`ford`]: https://github.com/Fortran-FOSS-Programmers/ford
 [`fpm`]: https://github.com/fortran-lang/fpm
+[Getting Started]: #getting-started
 [GitHub Pages site]: https://berkeleylab.github.io/inference-engine/ 
 [handy-dandy]: https://github.com/rouson/handy-dandy/blob/main/src
 [ICAR]: https://github.com/BerkeleyLab/icar/tree/neural-net
 [JSON]: https://www.json.org/json-en.html
+[LLVM]: https://github.com/llvm/llvm-project
 [nexport]: https://go.lbl.gov/nexport
+[Overview]: #overview
 [ROCm fork]: https://github.com/ROCm/llvm-project
 [rojff]: https://gitlab.com/everythingfunctional/rojff
-[saturated_mixing_ratio_m]: example/supporting-files/saturated_mixing_ratio_m.f90
-[Overview]: #overview
-[Getting Started]: #getting-started
-[Documentation]: #documentation
-[Building and testing]: #building-and-testing
+[saturated_mixing_ratio_m]: example/supporting-modules/saturated_mixing_ratio_m.f90

index.html

@@ -133,7 +133,7 @@ <h3 id="examples-and-demonstration-applications">Examples and demonstration appl
 <h3 id="building-and-testing">Building and Testing</h3>
 <p>Because this repository supports programming language research, the code exercises new language features in novel ways.
 We recommend using any compiler's latest release or even building open-source compilers from source.
-The <a href="https://github.com/rouson/handy-dandy/blob/main/src">handy-dandy</a> repository contains scripts capturing steps for building the [llvm-project] compiler.
+The <a href="https://github.com/rouson/handy-dandy/blob/main/src">handy-dandy</a> repository contains scripts capturing steps for building the <a href="https://github.com/llvm/llvm-project">LLVM</a> compiler suite.
 The remainder of this section contains commands for building Inference-Engine with a recent Fortran compiler and the Fortran Package Manager ([<code>fpm</code>]) in your <code>PATH</code>.</p>
 <h4 id="gnu-gfortran-13-or-higher-required">GNU (<code>gfortran</code>) 13 or higher required</h4>
 <div class="codehilite"><pre><span></span><code>fpm test --compiler gfortran --profile release
@@ -209,7 +209,7 @@ <h3 id="configuring-a-training-run">Configuring a training run</h3>
 Files with added or removed white space or reordered whole objects ("hyperparameters" or "network configuration") should work.
 A future release will leverage the <a href="https://gitlab.com/everythingfunctional/rojff">rojff</a> JSON interface to allow for more flexible file formatting.</p>
 <h3 id="training-a-neural-network">Training a neural network</h3>
-<p>Running the following command will train a neural network to learn the saturated mixing ratio function that is one component of the ICAR SB04 cloud microphysics model (see the <a href="example/supporting-files/saturated_mixing_ratio_m.f90">saturated_mixing_ratio_m</a> module for an implementation of the involved function):</p>
+<p>Running the following command will train a neural network to learn the saturated mixing ratio function that is one component of the ICAR SB04 cloud microphysics model (see the <a href="example/supporting-modules/saturated_mixing_ratio_m.f90">saturated_mixing_ratio_m</a> module for an implementation of the involved function):</p>
 <div class="codehilite"><pre><span></span><code> fpm run --example learn-saturated-mixing-ratio --compiler gfortran --profile release -- --output-file sat-mix-rat.json
 </code></pre></div>
 
@@ -226,7 +226,7 @@ <h3 id="training-a-neural-network">Training a neural network</h3>
 The program also writes the neural network initial condition to <code>initial-network.json</code> and the final (trained) network to the file specified in the above command: <code>sat-mix-rat.json</code>.</p>
 <h3 id="performing-inference">Performing inference</h3>
 <p>Users with a PyTorch model may use <a href="https://go.lbl.gov/nexport">nexport</a> to export the model to JSON files that Inference-Engine can read.
-Examples of performing inference using a neural-network JSON file are in <a href="example/concurrent-inferences">example/concurrent-inferences</a>.</p>
+Examples of performing inference using a neural-network JSON file are in <a href="example/concurrent-inferences.f90">example/concurrent-inferences</a>.</p>
 <h2 id="documentation">Documentation</h2>
 <p>Please see our <a href="https://berkeleylab.github.io/inference-engine/">GitHub Pages site</a> for HTML documentation generated by [<code>ford</code>] or generate documentaiton locally by installing <code>ford</code> and executing <code>ford ford.md</code>.</p>
         </div>
@@ -310,7 +310,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-09-20 03:37              </p>
+ on 2024-09-20 04:53              </p>
           </div>
         </div>
         <br>

interface/activation.html

@@ -164,35 +164,35 @@ <h3 class="card-title">Called by</h3>
 <polygon fill="none" stroke="black" points="283.29,-45.27 158.52,-45.27 158.52,-21 283.29,-21 283.29,-45.27"/>
 <text text-anchor="middle" x="220.9" y="-29.53" font-family="Helvetica,sans-Serif" font-size="10.50">sigmoid_t%activation</text>
 </g>
-<!-- proc~activation -->
+<!-- proc~activation_derivative~2 -->
 <g id="interface~~activation~~CalledByGraph_node2" class="node">
-<title>proc~activation</title>
-<g id="a_interface~~activation~~CalledByGraph_node2"><a xlink:href="../proc/activation.html" xlink:title="activation">
-<polygon fill="#d94e8f" stroke="#d94e8f" points="93.27,-66.27 29.25,-66.27 29.25,-42 93.27,-42 93.27,-66.27"/>
-<text text-anchor="middle" x="61.26" y="-50.53" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">activation</text>
+<title>proc~activation_derivative~2</title>
+<g id="a_interface~~activation~~CalledByGraph_node2"><a xlink:href="../proc/activation_derivative~2.html" xlink:title="activation_derivative">
+<polygon fill="#d94e8f" stroke="#d94e8f" points="122.52,-66.27 0,-66.27 0,-42 122.52,-42 122.52,-66.27"/>
+<text text-anchor="middle" x="61.26" y="-50.53" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">activation_derivative</text>
 </a>
 </g>
 </g>
-<!-- proc~activation&#45;&gt;interface~activation -->
+<!-- proc~activation_derivative~2&#45;&gt;interface~activation -->
 <g id="interface~~activation~~CalledByGraph_edge1" class="edge">
-<title>proc~activation&#45;&gt;interface~activation</title>
-<path fill="none" stroke="#ff0000" d="M93.41,-49.99C108.79,-47.94 128.04,-45.37 146.86,-42.87"/>
-<polygon fill="#ff0000" stroke="#ff0000" points="147.22,-46.35 156.67,-41.56 146.29,-39.41 147.22,-46.35"/>
+<title>proc~activation_derivative~2&#45;&gt;interface~activation</title>
+<path fill="none" stroke="#ff0000" d="M122.76,-46.08C130.67,-45.02 138.84,-43.93 146.92,-42.86"/>
+<polygon fill="#ff0000" stroke="#ff0000" points="147.31,-46.34 156.76,-41.55 146.39,-39.4 147.31,-46.34"/>
 </g>
-<!-- proc~activation_derivative -->
+<!-- proc~activation~2 -->
 <g id="interface~~activation~~CalledByGraph_node3" class="node">
-<title>proc~activation_derivative</title>
-<g id="a_interface~~activation~~CalledByGraph_node3"><a xlink:href="../proc/activation_derivative.html" xlink:title="activation_derivative">
-<polygon fill="#d94e8f" stroke="#d94e8f" points="122.52,-24.27 0,-24.27 0,0 122.52,0 122.52,-24.27"/>
-<text text-anchor="middle" x="61.26" y="-8.53" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">activation_derivative</text>
+<title>proc~activation~2</title>
+<g id="a_interface~~activation~~CalledByGraph_node3"><a xlink:href="../proc/activation~2.html" xlink:title="activation">
+<polygon fill="#d94e8f" stroke="#d94e8f" points="93.27,-24.27 29.25,-24.27 29.25,0 93.27,0 93.27,-24.27"/>
+<text text-anchor="middle" x="61.26" y="-8.53" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">activation</text>
 </a>
 </g>
 </g>
-<!-- proc~activation_derivative&#45;&gt;interface~activation -->
+<!-- proc~activation~2&#45;&gt;interface~activation -->
 <g id="interface~~activation~~CalledByGraph_edge2" class="edge">
-<title>proc~activation_derivative&#45;&gt;interface~activation</title>
-<path fill="none" stroke="#ff0000" d="M122.76,-20.19C130.67,-21.25 138.84,-22.34 146.92,-23.41"/>
-<polygon fill="#ff0000" stroke="#ff0000" points="146.39,-26.87 156.76,-24.72 147.31,-19.93 146.39,-26.87"/>
+<title>proc~activation~2&#45;&gt;interface~activation</title>
+<path fill="none" stroke="#ff0000" d="M93.41,-16.28C108.79,-18.33 128.04,-20.9 146.86,-23.4"/>
+<polygon fill="#ff0000" stroke="#ff0000" points="146.29,-26.86 156.67,-24.71 147.22,-19.92 146.29,-26.86"/>
 </g>
 </g>
 </svg>
@@ -279,7 +279,7 @@ <h4 class="modal-title" id="-graph-help-label">Graph Key</h4>
     </div>
     <br>
       <h2>private elemental module function activation(x) result(y)  
-    <a href="../proc/activation~5.html"><button type="button" class="btn btn-info depwarn">Implementation &rarr;</button></a>
+    <a href="../proc/activation~3.html"><button type="button" class="btn btn-info depwarn">Implementation &rarr;</button></a>
 </h2>
 
 
@@ -335,7 +335,7 @@ <h3>Return Value <span class="anchor" id="variable-y"></span><small>real(kind=rk
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-09-20 03:37              </p>
+ on 2024-09-20 04:53              </p>
           </div>
         </div>
         <br>

interface/activation_derivative.html

@@ -164,18 +164,18 @@ <h3 class="card-title">Called by</h3>
 <polygon fill="none" stroke="black" points="341.79,-24.27 158.52,-24.27 158.52,0 341.79,0 341.79,-24.27"/>
 <text text-anchor="middle" x="250.16" y="-8.53" font-family="Helvetica,sans-Serif" font-size="10.50">sigmoid_t%activation_derivative</text>
 </g>
-<!-- proc~activation_derivative -->
+<!-- proc~activation_derivative~2 -->
 <g id="interface~~activation_derivative~~CalledByGraph_node2" class="node">
-<title>proc~activation_derivative</title>
-<g id="a_interface~~activation_derivative~~CalledByGraph_node2"><a xlink:href="../proc/activation_derivative.html" xlink:title="activation_derivative">
+<title>proc~activation_derivative~2</title>
+<g id="a_interface~~activation_derivative~~CalledByGraph_node2"><a xlink:href="../proc/activation_derivative~2.html" xlink:title="activation_derivative">
 <polygon fill="#d94e8f" stroke="#d94e8f" points="122.52,-24.27 0,-24.27 0,0 122.52,0 122.52,-24.27"/>
 <text text-anchor="middle" x="61.26" y="-8.53" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">activation_derivative</text>
 </a>
 </g>
 </g>
-<!-- proc~activation_derivative&#45;&gt;interface~activation_derivative -->
+<!-- proc~activation_derivative~2&#45;&gt;interface~activation_derivative -->
 <g id="interface~~activation_derivative~~CalledByGraph_edge1" class="edge">
-<title>proc~activation_derivative&#45;&gt;interface~activation_derivative</title>
+<title>proc~activation_derivative~2&#45;&gt;interface~activation_derivative</title>
 <path fill="none" stroke="#ff0000" d="M122.94,-12.13C130.62,-12.13 138.64,-12.13 146.74,-12.13"/>
 <polygon fill="#ff0000" stroke="#ff0000" points="146.73,-15.64 156.73,-12.14 146.73,-8.64 146.73,-15.64"/>
 </g>
@@ -264,7 +264,7 @@ <h4 class="modal-title" id="-graph-help-label">Graph Key</h4>
     </div>
     <br>
       <h2>private elemental module function activation_derivative(x) result(y)  
-    <a href="../proc/activation_derivative~4.html"><button type="button" class="btn btn-info depwarn">Implementation &rarr;</button></a>
+    <a href="../proc/activation_derivative~3.html"><button type="button" class="btn btn-info depwarn">Implementation &rarr;</button></a>
 </h2>
 
 
@@ -320,7 +320,7 @@ <h3>Return Value <span class="anchor" id="variable-y~2"></span><small>real(kind=
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-09-20 03:37              </p>
+ on 2024-09-20 04:53              </p>
           </div>
         </div>
         <br>

interface/activation_derivative~2.html

@@ -141,7 +141,7 @@ <h3>Contents</h3>
     <div class="col-md-9" id='text'>
       <h2>interface <br>
       private elemental module function activation_derivative(x) result(y)  
-    <a href="../proc/activation_derivative~3.html"><button type="button" class="btn btn-info depwarn">Implementation &rarr;</button></a>
+    <a href="../proc/activation_derivative.html"><button type="button" class="btn btn-info depwarn">Implementation &rarr;</button></a>
 </h2>    
 
 
@@ -159,7 +159,7 @@ <h3>Arguments</h3>
     <tbody>
         <tr>
             <td>
-              <span class="anchor" id="variable-x~6"></span>
+              <span class="anchor" id="variable-x~4"></span>
               real(kind=rkind),
             </td>
 <td>intent(in)</td>
@@ -175,7 +175,7 @@ <h3>Arguments</h3>
     </tbody>
   </table>
 
-      <h3>Return Value <span class="anchor" id="variable-y~6"></span><small>real(kind=rkind)</small></h3>
+      <h3>Return Value <span class="anchor" id="variable-y~4"></span><small>real(kind=rkind)</small></h3>
 
     <br>
 
@@ -197,7 +197,7 @@ <h3>Return Value <span class="anchor" id="variable-y~6"></span><small>real(kind=
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-09-20 03:37              </p>
+ on 2024-09-20 04:53              </p>
           </div>
         </div>
         <br>

interface/activation_derivative~3.html

@@ -141,7 +141,7 @@ <h3>Contents</h3>
     <div class="col-md-9" id='text'>
       <h2>interface <br>
       private elemental module function activation_derivative(x) result(y)  
-    <a href="../proc/activation_derivative~2.html"><button type="button" class="btn btn-info depwarn">Implementation &rarr;</button></a>
+    <a href="../proc/activation_derivative~4.html"><button type="button" class="btn btn-info depwarn">Implementation &rarr;</button></a>
 </h2>    
 
 
@@ -159,7 +159,7 @@ <h3>Arguments</h3>
     <tbody>
         <tr>
             <td>
-              <span class="anchor" id="variable-x~8"></span>
+              <span class="anchor" id="variable-x~6"></span>
               real(kind=rkind),
             </td>
 <td>intent(in)</td>
@@ -175,7 +175,7 @@ <h3>Arguments</h3>
     </tbody>
   </table>
 
-      <h3>Return Value <span class="anchor" id="variable-y~8"></span><small>real(kind=rkind)</small></h3>
+      <h3>Return Value <span class="anchor" id="variable-y~6"></span><small>real(kind=rkind)</small></h3>
 
     <br>
 
@@ -197,7 +197,7 @@ <h3>Return Value <span class="anchor" id="variable-y~8"></span><small>real(kind=
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-09-20 03:37              </p>
+ on 2024-09-20 04:53              </p>
           </div>
         </div>
         <br>

interface/activation_derivative~4.html

@@ -141,7 +141,7 @@ <h3>Contents</h3>
     <div class="col-md-9" id='text'>
       <h2>interface <br>
       private elemental module function activation_derivative(x) result(y)  
-    <a href="../proc/activation_derivative.html"><button type="button" class="btn btn-info depwarn">Implementation &rarr;</button></a>
+    <a href="../proc/activation_derivative~2.html"><button type="button" class="btn btn-info depwarn">Implementation &rarr;</button></a>
 </h2>    
 
 
@@ -197,7 +197,7 @@ <h3>Return Value <span class="anchor" id="variable-y~10"></span><small>real(kind
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-09-20 03:37              </p>
+ on 2024-09-20 04:53              </p>
           </div>
         </div>
         <br>

interface/activation_function_name.html

@@ -312,7 +312,7 @@ <h3>Arguments</h3>
     <tbody>
         <tr>
             <td>
-              <span class="anchor" id="variable-self~55"></span>
+              <span class="anchor" id="variable-self~67"></span>
               class(<a href='../type/inference_engine_t.html'>inference_engine_t</a>),
             </td>
 <td>intent(in)</td>
@@ -350,7 +350,7 @@ <h3>Return Value <span class="anchor" id="variable-activation_name~5"></span><sm
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-09-20 03:37              </p>
+ on 2024-09-20 04:53              </p>
           </div>
         </div>
         <br>

interface/activation_i.html

@@ -158,7 +158,7 @@ <h3>Arguments</h3>
     <tbody>
         <tr>
             <td>
-              <span class="anchor" id="variable-x~4"></span>
+              <span class="anchor" id="variable-x~7"></span>
               real(kind=rkind),
             </td>
 <td>intent(in)</td>
@@ -174,7 +174,7 @@ <h3>Arguments</h3>
     </tbody>
   </table>
 
-      <h3>Return Value <span class="anchor" id="variable-y~4"></span><small>real(kind=rkind)</small></h3>
+      <h3>Return Value <span class="anchor" id="variable-y~7"></span><small>real(kind=rkind)</small></h3>
 
     <br>
 
@@ -196,7 +196,7 @@ <h3>Return Value <span class="anchor" id="variable-y~4"></span><small>real(kind=
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-09-20 03:37              </p>
+ on 2024-09-20 04:53              </p>
           </div>
         </div>
         <br>

interface/activation_name.html

@@ -282,7 +282,7 @@ <h3>Arguments</h3>
     <tbody>
         <tr>
             <td>
-              <span class="anchor" id="variable-self~25"></span>
+              <span class="anchor" id="variable-self~26"></span>
               class(<a href='../type/network_configuration_t.html'>network_configuration_t</a>),
             </td>
 <td>intent(in)</td>
@@ -320,7 +320,7 @@ <h3>Return Value <span class="anchor" id="variable-string~5"></span><small>type(
             <p class="text-end">
               Documentation generated by
               <a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
- on 2024-09-20 03:37              </p>
+ on 2024-09-20 04:53              </p>
           </div>
         </div>
         <br>