update docs at commit: Merge pull request #124 from yardasol/missing-…

…docs Missing docs 498effa
arfc · Feb 14, 2022 · f9aabd8 · f9aabd8
1 parent 8b274ef
commit f9aabd8
Show file tree

Hide file tree

Showing 69 changed files with 1,743 additions and 14 deletions.
diff --git a/master/.buildinfo b/master/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: b9791773a19836b530ac783326311491
+config: 52f4bea6dc465d51ad7ff372ea1c35de
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/master/.doctrees/devguide/contributing.doctree b/master/.doctrees/devguide/contributing.doctree
diff --git a/master/.doctrees/devguide/index.doctree b/master/.doctrees/devguide/index.doctree
diff --git a/master/.doctrees/environment.pickle b/master/.doctrees/environment.pickle
diff --git a/master/.doctrees/examples.doctree b/master/.doctrees/examples.doctree
diff --git a/master/.doctrees/index.doctree b/master/.doctrees/index.doctree
diff --git a/master/.doctrees/installation.doctree b/master/.doctrees/installation.doctree
diff --git a/master/.doctrees/overview.doctree b/master/.doctrees/overview.doctree
diff --git a/master/.doctrees/releasenotes/index.doctree b/master/.doctrees/releasenotes/index.doctree
diff --git a/master/.doctrees/releasenotes/template.doctree b/master/.doctrees/releasenotes/template.doctree
diff --git a/master/.doctrees/releasenotes/v0.3.0.doctree b/master/.doctrees/releasenotes/v0.3.0.doctree
diff --git a/master/.doctrees/releasenotes/v0.4.0.doctree b/master/.doctrees/releasenotes/v0.4.0.doctree
diff --git a/master/.doctrees/src/index.doctree b/master/.doctrees/src/index.doctree
diff --git a/master/.doctrees/src/modules.doctree b/master/.doctrees/src/modules.doctree
diff --git a/master/.doctrees/src/saltproc.app.doctree b/master/.doctrees/src/saltproc.app.doctree
diff --git a/master/.doctrees/src/saltproc.depcode.doctree b/master/.doctrees/src/saltproc.depcode.doctree
diff --git a/master/.doctrees/src/saltproc.doctree b/master/.doctrees/src/saltproc.doctree
diff --git a/master/.doctrees/src/saltproc.materialflow.doctree b/master/.doctrees/src/saltproc.materialflow.doctree
diff --git a/master/.doctrees/src/saltproc.process.doctree b/master/.doctrees/src/saltproc.process.doctree
diff --git a/master/.doctrees/src/saltproc.reactor.doctree b/master/.doctrees/src/saltproc.reactor.doctree
diff --git a/master/.doctrees/src/saltproc.separator.doctree b/master/.doctrees/src/saltproc.separator.doctree
diff --git a/master/.doctrees/src/saltproc.simulation.doctree b/master/.doctrees/src/saltproc.simulation.doctree
diff --git a/master/.doctrees/src/saltproc.sparger.doctree b/master/.doctrees/src/saltproc.sparger.doctree
diff --git a/master/.doctrees/src/saltproc.tests.doctree b/master/.doctrees/src/saltproc.tests.doctree
diff --git a/master/.doctrees/src/saltproc.tests.test_app.doctree b/master/.doctrees/src/saltproc.tests.test_app.doctree
diff --git a/master/.doctrees/src/saltproc.tests.test_depcode.doctree b/master/.doctrees/src/saltproc.tests.test_depcode.doctree
diff --git a/master/.doctrees/src/saltproc.tests.test_materialflow.doctree b/master/.doctrees/src/saltproc.tests.test_materialflow.doctree
diff --git a/master/.doctrees/src/saltproc.tests.test_process.doctree b/master/.doctrees/src/saltproc.tests.test_process.doctree
diff --git a/master/.doctrees/src/saltproc.tests.test_separator.doctree b/master/.doctrees/src/saltproc.tests.test_separator.doctree
diff --git a/master/.doctrees/src/saltproc.tests.test_simulation.doctree b/master/.doctrees/src/saltproc.tests.test_simulation.doctree
diff --git a/master/.doctrees/src/saltproc.tests.test_sparger.doctree b/master/.doctrees/src/saltproc.tests.test_sparger.doctree
diff --git a/master/.doctrees/src/saltproc.version.doctree b/master/.doctrees/src/saltproc.version.doctree
diff --git a/master/_modules/index.html b/master/_modules/index.html
@@ -71,17 +71,20 @@
            <div itemprop="articleBody">
 
   <h1>All modules for which code is available</h1>
-<ul><li><a href="saltproc/depcode.html">saltproc.depcode</a></li>
+<ul><li><a href="saltproc/app.html">saltproc.app</a></li>
+<li><a href="saltproc/depcode.html">saltproc.depcode</a></li>
 <li><a href="saltproc/materialflow.html">saltproc.materialflow</a></li>
 <li><a href="saltproc/process.html">saltproc.process</a></li>
 <li><a href="saltproc/reactor.html">saltproc.reactor</a></li>
 <li><a href="saltproc/separator.html">saltproc.separator</a></li>
 <li><a href="saltproc/simulation.html">saltproc.simulation</a></li>
 <li><a href="saltproc/sparger.html">saltproc.sparger</a></li>
+<li><a href="saltproc/tests/test_app.html">saltproc.tests.test_app</a></li>
 <li><a href="saltproc/tests/test_depcode.html">saltproc.tests.test_depcode</a></li>
 <li><a href="saltproc/tests/test_materialflow.html">saltproc.tests.test_materialflow</a></li>
 <li><a href="saltproc/tests/test_process.html">saltproc.tests.test_process</a></li>
 <li><a href="saltproc/tests/test_separator.html">saltproc.tests.test_separator</a></li>
+<li><a href="saltproc/tests/test_simulation.html">saltproc.tests.test_simulation</a></li>
 <li><a href="saltproc/tests/test_sparger.html">saltproc.tests.test_sparger</a></li>
 </ul>
 

diff --git a/master/_modules/saltproc/app.html b/master/_modules/saltproc/app.html
diff --git a/master/_modules/saltproc/tests/test_app.html b/master/_modules/saltproc/tests/test_app.html
diff --git a/master/_modules/saltproc/tests/test_simulation.html b/master/_modules/saltproc/tests/test_simulation.html
diff --git a/master/genindex.html b/master/genindex.html
@@ -277,6 +277,8 @@ <h2 id="M">M</h2>
 
       <ul>
         <li><a href="src/saltproc.html#module-saltproc">saltproc</a>
+</li>
+        <li><a href="src/saltproc.app.html#module-saltproc.app">saltproc.app</a>
 </li>
         <li><a href="src/saltproc.depcode.html#module-saltproc.depcode">saltproc.depcode</a>
 </li>
@@ -293,6 +295,8 @@ <h2 id="M">M</h2>
         <li><a href="src/saltproc.sparger.html#module-saltproc.sparger">saltproc.sparger</a>
 </li>
         <li><a href="src/saltproc.tests.html#module-saltproc.tests">saltproc.tests</a>
+</li>
+        <li><a href="src/saltproc.tests.test_app.html#module-saltproc.tests.test_app">saltproc.tests.test_app</a>
 </li>
         <li><a href="src/saltproc.tests.test_depcode.html#module-saltproc.tests.test_depcode">saltproc.tests.test_depcode</a>
 </li>
@@ -301,6 +305,8 @@ <h2 id="M">M</h2>
         <li><a href="src/saltproc.tests.test_process.html#module-saltproc.tests.test_process">saltproc.tests.test_process</a>
 </li>
         <li><a href="src/saltproc.tests.test_separator.html#module-saltproc.tests.test_separator">saltproc.tests.test_separator</a>
+</li>
+        <li><a href="src/saltproc.tests.test_simulation.html#module-saltproc.tests.test_simulation">saltproc.tests.test_simulation</a>
 </li>
         <li><a href="src/saltproc.tests.test_sparger.html#module-saltproc.tests.test_sparger">saltproc.tests.test_sparger</a>
 </li>
@@ -313,10 +319,12 @@ <h2 id="M">M</h2>
 <h2 id="P">P</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="src/saltproc.materialflow.html#saltproc.materialflow.Materialflow.print_attr">print_attr() (saltproc.materialflow.Materialflow method)</a>
+      <li><a href="src/saltproc.app.html#saltproc.app.parse_arguments">parse_arguments() (in module saltproc.app)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="src/saltproc.materialflow.html#saltproc.materialflow.Materialflow.print_attr">print_attr() (saltproc.materialflow.Materialflow method)</a>
+</li>
       <li><a href="src/saltproc.process.html#saltproc.process.Process">Process (class in saltproc.process)</a>
 </li>
   </ul></td>
@@ -365,15 +373,29 @@ <h2 id="R">R</h2>
         <li><a href="src/saltproc.depcode.html#saltproc.depcode.DepcodeSerpent.read_depcode_step_param">(saltproc.depcode.DepcodeSerpent method)</a>
 </li>
       </ul></li>
+      <li><a href="src/saltproc.app.html#saltproc.app.read_dot">read_dot() (in module saltproc.app)</a>
+</li>
+      <li><a href="src/saltproc.app.html#saltproc.app.read_feeds_from_input">read_feeds_from_input() (in module saltproc.app)</a>
+</li>
+      <li><a href="src/saltproc.simulation.html#saltproc.simulation.Simulation.read_k_eds_delta">read_k_eds_delta() (saltproc.simulation.Simulation method)</a>
+</li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="src/saltproc.simulation.html#saltproc.simulation.Simulation.read_k_eds_delta">read_k_eds_delta() (saltproc.simulation.Simulation method)</a>
+      <li><a href="src/saltproc.app.html#saltproc.app.read_main_input">read_main_input() (in module saltproc.app)</a>
 </li>
       <li><a href="src/saltproc.depcode.html#saltproc.depcode.DepcodeSerpent.read_plaintext_file">read_plaintext_file() (saltproc.depcode.DepcodeSerpent method)</a>
+</li>
+      <li><a href="src/saltproc.app.html#saltproc.app.read_processes_from_input">read_processes_from_input() (in module saltproc.app)</a>
+</li>
+      <li><a href="src/saltproc.app.html#saltproc.app.refill">refill() (in module saltproc.app)</a>
 </li>
       <li><a href="src/saltproc.process.html#saltproc.process.Process.rem_elements">rem_elements() (saltproc.process.Process method)</a>
 </li>
       <li><a href="src/saltproc.depcode.html#saltproc.depcode.DepcodeSerpent.replace_burnup_parameters">replace_burnup_parameters() (saltproc.depcode.DepcodeSerpent method)</a>
+</li>
+      <li><a href="src/saltproc.app.html#saltproc.app.reprocessing">reprocessing() (in module saltproc.app)</a>
+</li>
+      <li><a href="src/saltproc.app.html#saltproc.app.run">run() (in module saltproc.app)</a>
 </li>
       <li><a href="src/saltproc.depcode.html#saltproc.depcode.Depcode.run_depcode">run_depcode() (saltproc.depcode.Depcode method)</a>
 
@@ -392,6 +414,13 @@ <h2 id="S">S</h2>
 
       <ul>
         <li><a href="src/saltproc.html#module-saltproc">module</a>
+</li>
+      </ul></li>
+      <li>
+    saltproc.app
+
+      <ul>
+        <li><a href="src/saltproc.app.html#module-saltproc.app">module</a>
 </li>
       </ul></li>
       <li>
@@ -448,6 +477,13 @@ <h2 id="S">S</h2>
 
       <ul>
         <li><a href="src/saltproc.tests.html#module-saltproc.tests">module</a>
+</li>
+      </ul></li>
+      <li>
+    saltproc.tests.test_app
+
+      <ul>
+        <li><a href="src/saltproc.tests.test_app.html#module-saltproc.tests.test_app">module</a>
 </li>
       </ul></li>
       <li>
@@ -478,6 +514,13 @@ <h2 id="S">S</h2>
 
       <ul>
         <li><a href="src/saltproc.tests.test_separator.html#module-saltproc.tests.test_separator">module</a>
+</li>
+      </ul></li>
+      <li>
+    saltproc.tests.test_simulation
+
+      <ul>
+        <li><a href="src/saltproc.tests.test_simulation.html#module-saltproc.tests.test_simulation">module</a>
 </li>
       </ul></li>
       <li>
@@ -533,6 +576,8 @@ <h2 id="T">T</h2>
       <li><a href="src/saltproc.sparger.html#saltproc.sparger.Sparger.temp_salt">temp_salt (saltproc.sparger.Sparger attribute)</a>
 </li>
       <li><a href="src/saltproc.tests.test_depcode.html#saltproc.tests.test_depcode.test_change_sim_par">test_change_sim_par() (in module saltproc.tests.test_depcode)</a>
+</li>
+      <li><a href="src/saltproc.tests.test_simulation.html#saltproc.tests.test_simulation.test_check_switch_geo_trigger">test_check_switch_geo_trigger() (in module saltproc.tests.test_simulation)</a>
 </li>
       <li><a href="src/saltproc.tests.test_depcode.html#saltproc.tests.test_depcode.test_convert_nuclide_name_serpent_to_zam">test_convert_nuclide_name_serpent_to_zam() (in module saltproc.tests.test_depcode)</a>
 </li>
@@ -548,15 +593,27 @@ <h2 id="T">T</h2>
 </li>
       <li><a href="src/saltproc.tests.test_depcode.html#saltproc.tests.test_depcode.test_insert_path_to_geometry">test_insert_path_to_geometry() (in module saltproc.tests.test_depcode)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="src/saltproc.tests.test_depcode.html#saltproc.tests.test_depcode.test_read_dep_comp">test_read_dep_comp() (in module saltproc.tests.test_depcode)</a>
 </li>
       <li><a href="src/saltproc.tests.test_depcode.html#saltproc.tests.test_depcode.test_read_depcode_info">test_read_depcode_info() (in module saltproc.tests.test_depcode)</a>
 </li>
       <li><a href="src/saltproc.tests.test_depcode.html#saltproc.tests.test_depcode.test_read_depcode_step_param">test_read_depcode_step_param() (in module saltproc.tests.test_depcode)</a>
+</li>
+      <li><a href="src/saltproc.tests.test_app.html#saltproc.tests.test_app.test_read_dot">test_read_dot() (in module saltproc.tests.test_app)</a>
+</li>
+      <li><a href="src/saltproc.tests.test_app.html#saltproc.tests.test_app.test_read_feeds_from_input">test_read_feeds_from_input() (in module saltproc.tests.test_app)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="src/saltproc.tests.test_simulation.html#saltproc.tests.test_simulation.test_read_k_eds_delta">test_read_k_eds_delta() (in module saltproc.tests.test_simulation)</a>
+</li>
+      <li><a href="src/saltproc.tests.test_app.html#saltproc.tests.test_app.test_read_main_input">test_read_main_input() (in module saltproc.tests.test_app)</a>
 </li>
       <li><a href="src/saltproc.tests.test_depcode.html#saltproc.tests.test_depcode.test_read_plaintext_file">test_read_plaintext_file() (in module saltproc.tests.test_depcode)</a>
+</li>
+      <li><a href="src/saltproc.tests.test_app.html#saltproc.tests.test_app.test_read_processes_from_input">test_read_processes_from_input() (in module saltproc.tests.test_app)</a>
+</li>
+      <li><a href="src/saltproc.tests.test_app.html#saltproc.tests.test_app.test_refill">test_refill() (in module saltproc.tests.test_app)</a>
 </li>
       <li><a href="src/saltproc.tests.test_process.html#saltproc.tests.test_process.test_rem_elements">test_rem_elements() (in module saltproc.tests.test_process)</a>
 
@@ -567,8 +624,18 @@ <h2 id="T">T</h2>
 </li>
       </ul></li>
       <li><a href="src/saltproc.tests.test_depcode.html#saltproc.tests.test_depcode.test_replace_burnup_parameters">test_replace_burnup_parameters() (in module saltproc.tests.test_depcode)</a>
+</li>
+      <li><a href="src/saltproc.tests.test_app.html#saltproc.tests.test_app.test_reprocessing">test_reprocessing() (in module saltproc.tests.test_app)</a>
 </li>
       <li><a href="src/saltproc.tests.test_materialflow.html#saltproc.tests.test_materialflow.test_scale_matflow">test_scale_matflow() (in module saltproc.tests.test_materialflow)</a>
+</li>
+      <li><a href="src/saltproc.tests.test_simulation.html#saltproc.tests.test_simulation.test_store_after_repr">test_store_after_repr() (in module saltproc.tests.test_simulation)</a>
+</li>
+      <li><a href="src/saltproc.tests.test_simulation.html#saltproc.tests.test_simulation.test_store_mat_data">test_store_mat_data() (in module saltproc.tests.test_simulation)</a>
+</li>
+      <li><a href="src/saltproc.tests.test_simulation.html#saltproc.tests.test_simulation.test_store_run_init_info">test_store_run_init_info() (in module saltproc.tests.test_simulation)</a>
+</li>
+      <li><a href="src/saltproc.tests.test_simulation.html#saltproc.tests.test_simulation.test_store_run_step_info">test_store_run_step_info() (in module saltproc.tests.test_simulation)</a>
 </li>
       <li><a href="src/saltproc.tests.test_depcode.html#saltproc.tests.test_depcode.test_switch_to_next_geometry">test_switch_to_next_geometry() (in module saltproc.tests.test_depcode)</a>
 </li>

diff --git a/master/objects.inv b/master/objects.inv
diff --git a/master/py-modindex.html b/master/py-modindex.html
@@ -90,6 +90,11 @@ <h1>Python Module Index</h1>
        <td>
        <a href="src/saltproc.html#module-saltproc"><code class="xref">saltproc</code></a></td><td>
        <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="src/saltproc.app.html#module-saltproc.app"><code class="xref">saltproc.app</code></a></td><td>
+       <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;
@@ -130,6 +135,11 @@ <h1>Python Module Index</h1>
        <td>&#160;&#160;&#160;
        <a href="src/saltproc.tests.html#module-saltproc.tests"><code class="xref">saltproc.tests</code></a></td><td>
        <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="src/saltproc.tests.test_app.html#module-saltproc.tests.test_app"><code class="xref">saltproc.tests.test_app</code></a></td><td>
+       <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;
@@ -150,6 +160,11 @@ <h1>Python Module Index</h1>
        <td>&#160;&#160;&#160;
        <a href="src/saltproc.tests.test_separator.html#module-saltproc.tests.test_separator"><code class="xref">saltproc.tests.test_separator</code></a></td><td>
        <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="src/saltproc.tests.test_simulation.html#module-saltproc.tests.test_simulation"><code class="xref">saltproc.tests.test_simulation</code></a></td><td>
+       <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;

diff --git a/master/searchindex.js b/master/searchindex.js