Updating the doc and some minor chanegs

snaeimi · Jul 19, 2024 · 2a54e81 · 2a54e81
1 parent b161ed9
commit 2a54e81
Show file tree

Hide file tree

Showing 23 changed files with 251 additions and 14 deletions.
diff --git a/.gitignore b/.gitignore
@@ -3,6 +3,7 @@ MPI_results/
 MPI_results - Copy/
 __pycache__
 Demand Polygons/
+_build
 *.cpg
 *.dbf
 *.prj

diff --git a/doc/_build/doctrees/docs/Future.doctree b/doc/_build/doctrees/docs/Future.doctree
diff --git a/doc/_build/doctrees/docs/Restoration_Plan_Config_File.doctree b/doc/_build/doctrees/docs/Restoration_Plan_Config_File.doctree
diff --git a/doc/_build/doctrees/docs/WorkflowDescription.doctree b/doc/_build/doctrees/docs/WorkflowDescription.doctree
diff --git a/doc/_build/doctrees/docs/install.doctree b/doc/_build/doctrees/docs/install.doctree
diff --git a/doc/_build/doctrees/environment.pickle b/doc/_build/doctrees/environment.pickle
diff --git a/doc/_build/doctrees/index.doctree b/doc/_build/doctrees/index.doctree
diff --git a/doc/_build/html/.buildinfo b/doc/_build/html/.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: edb0b896e67384c823c3f43a33aecf4f
+config: 98375070fa9b3bcc542e9fbd708c15a9
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/doc/_build/html/_sources/index.rst.txt b/doc/_build/html/_sources/index.rst.txt
@@ -3,19 +3,26 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to REWET's documentation!
+Welcome to REWET's Documentation
 #################################
 
+REstoration of Water after Event Tool (REWET) is a tool for simulating the functionality of water distribution networks after natural hazard events. It is designed to support any network with state-of-the-art hydraulic simulation capabilities and damage modeling.
+
+Table of Content
+****************
+
 The following compromises the content of the documentation.
 
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
    docs/install.rst
+   docs/inputs.rst
    docs/WorkflowDescription.rst
    docs/Restoration_Plan_Config_File.rst
    docs/Future.rst
+   docs/cite.rst
 
 
 

diff --git a/doc/_build/html/docs/Restoration_Plan_Config_File.html b/doc/_build/html/docs/Restoration_Plan_Config_File.html
@@ -16,6 +16,7 @@
   <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
   <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
   <link rel="stylesheet" href="../_static/tabs.css" type="text/css" />
+  <link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
 
 
 
@@ -96,6 +97,7 @@
               <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="install.html">Install</a></li>
+<li class="toctree-l1"><a class="reference internal" href="inputs.html">Inputs</a></li>
 <li class="toctree-l1"><a class="reference internal" href="WorkflowDescription.html">Workflow Description</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Restoration Plan</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#files">Files</a></li>

diff --git a/doc/_build/html/docs/WorkflowDescription.html b/doc/_build/html/docs/WorkflowDescription.html
@@ -16,6 +16,7 @@
   <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
   <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
   <link rel="stylesheet" href="../_static/tabs.css" type="text/css" />
+  <link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
 
 
 
@@ -45,7 +46,7 @@
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
     <link rel="next" title="Restoration Plan" href="Restoration_Plan_Config_File.html" />
-    <link rel="prev" title="Install" href="install.html" /> 
+    <link rel="prev" title="Inputs" href="inputs.html" /> 
 </head>
 
 <body class="wy-body-for-nav">
@@ -96,6 +97,7 @@
               <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="install.html">Install</a></li>
+<li class="toctree-l1"><a class="reference internal" href="inputs.html">Inputs</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Workflow Description</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Restoration_Plan_Config_File.html">Restoration Plan</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Future.html">Future Development</a></li>
@@ -177,7 +179,7 @@ <h1>Workflow Description<a class="headerlink" href="#workflow-description" title
           <footer>
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
         <a href="Restoration_Plan_Config_File.html" class="btn btn-neutral float-right" title="Restoration Plan" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
-        <a href="install.html" class="btn btn-neutral float-left" title="Install" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="inputs.html" class="btn btn-neutral float-left" title="Inputs" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
     </div>
 
   <hr/>

diff --git a/doc/_build/html/docs/future.html b/doc/_build/html/docs/future.html
@@ -16,6 +16,7 @@
   <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
   <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
   <link rel="stylesheet" href="../_static/tabs.css" type="text/css" />
+  <link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
 
 
 
@@ -95,6 +96,7 @@
               <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="install.html">Install</a></li>
+<li class="toctree-l1"><a class="reference internal" href="inputs.html">Inputs</a></li>
 <li class="toctree-l1"><a class="reference internal" href="WorkflowDescription.html">Workflow Description</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Restoration_Plan_Config_File.html">Restoration Plan</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Future Development</a><ul>

diff --git a/doc/_build/html/docs/install.html b/doc/_build/html/docs/install.html
@@ -16,6 +16,7 @@
   <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
   <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
   <link rel="stylesheet" href="../_static/tabs.css" type="text/css" />
+  <link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
 
 
 
@@ -45,7 +46,7 @@
 
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
-    <link rel="next" title="Workflow Description" href="WorkflowDescription.html" />
+    <link rel="next" title="Inputs" href="inputs.html" />
     <link rel="prev" title="Welcome to REWET&#39;s documentation!" href="../index.html" /> 
 </head>
 
@@ -103,6 +104,7 @@
 <li class="toctree-l2"><a class="reference internal" href="#test-installation">3. Test Installation</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="inputs.html">Inputs</a></li>
 <li class="toctree-l1"><a class="reference internal" href="WorkflowDescription.html">Workflow Description</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Restoration_Plan_Config_File.html">Restoration Plan</a></li>
 <li class="toctree-l1"><a class="reference internal" href="Future.html">Future Development</a></li>
@@ -248,7 +250,7 @@ <h2>3. Test Installation<a class="headerlink" href="#test-installation" title="P
           </div>
           <footer>
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
-        <a href="WorkflowDescription.html" class="btn btn-neutral float-right" title="Workflow Description" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+        <a href="inputs.html" class="btn btn-neutral float-right" title="Inputs" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
         <a href="../index.html" class="btn btn-neutral float-left" title="Welcome to REWET&#39;s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
     </div>
 

diff --git a/doc/_build/html/genindex.html b/doc/_build/html/genindex.html
@@ -16,6 +16,7 @@
   <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
   <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <link rel="stylesheet" href="_static/tabs.css" type="text/css" />
+  <link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
 
 
 
@@ -95,9 +96,11 @@
               <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="docs/install.html">Install</a></li>
+<li class="toctree-l1"><a class="reference internal" href="docs/inputs.html">Inputs</a></li>
 <li class="toctree-l1"><a class="reference internal" href="docs/WorkflowDescription.html">Workflow Description</a></li>
 <li class="toctree-l1"><a class="reference internal" href="docs/Restoration_Plan_Config_File.html">Restoration Plan</a></li>
 <li class="toctree-l1"><a class="reference internal" href="docs/Future.html">Future Development</a></li>
+<li class="toctree-l1"><a class="reference internal" href="docs/cite.html">How To Cite</a></li>
 </ul>
 
 

diff --git a/doc/_build/html/index.html b/doc/_build/html/index.html
@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
-  <title>Welcome to REWET&#39;s documentation! &mdash; REWET  documentation</title>
+  <title>Welcome to REWET&#39;s Documentation &mdash; REWET  documentation</title>
 
 
 
@@ -16,6 +16,7 @@
   <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
   <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <link rel="stylesheet" href="_static/tabs.css" type="text/css" />
+  <link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
 
 
 
@@ -95,9 +96,11 @@
               <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="docs/install.html">Install</a></li>
+<li class="toctree-l1"><a class="reference internal" href="docs/inputs.html">Inputs</a></li>
 <li class="toctree-l1"><a class="reference internal" href="docs/WorkflowDescription.html">Workflow Description</a></li>
 <li class="toctree-l1"><a class="reference internal" href="docs/Restoration_Plan_Config_File.html">Restoration Plan</a></li>
 <li class="toctree-l1"><a class="reference internal" href="docs/Future.html">Future Development</a></li>
+<li class="toctree-l1"><a class="reference internal" href="docs/cite.html">How To Cite</a></li>
 </ul>
 
 
@@ -146,7 +149,7 @@
 
       <li><a href="#" class="icon icon-home"></a> &raquo;</li>
 
-      <li>Welcome to REWET's documentation!</li>
+      <li>Welcome to REWET's Documentation</li>
 
 
       <li class="wy-breadcrumbs-aside">
@@ -166,7 +169,10 @@
            <div itemprop="articleBody">
 
   <div class="section" id="welcome-to-rewet-s-documentation">
-<h1>Welcome to REWET's documentation!<a class="headerlink" href="#welcome-to-rewet-s-documentation" title="Permalink to this heading">¶</a></h1>
+<h1>Welcome to REWET's Documentation<a class="headerlink" href="#welcome-to-rewet-s-documentation" title="Permalink to this heading">¶</a></h1>
+<p>REstoration of Water after Event Tool (REWET) is a tool for simulating the functionality of water distribution networks after natural hazard events. It is designed to support any network with state-of-the-art hydraulic simulation capabilities and damage modeling.</p>
+<div class="section" id="table-of-content">
+<h2>Table of Content<a class="headerlink" href="#table-of-content" title="Permalink to this heading">¶</a></h2>
 <p>The following compromises the content of the documentation.</p>
 <div class="toctree-wrapper compound">
 <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
@@ -178,6 +184,13 @@ <h1>Welcome to REWET's documentation!<a class="headerlink" href="#welcome-to-rew
 <li class="toctree-l2"><a class="reference internal" href="docs/install.html#test-installation">3. Test Installation</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="docs/inputs.html">Inputs</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="docs/inputs.html#overview">Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="docs/inputs.html#input-settings">Input Settings</a></li>
+<li class="toctree-l2"><a class="reference internal" href="docs/inputs.html#units-and-tips">Units and Tips</a></li>
+<li class="toctree-l2"><a class="reference internal" href="docs/inputs.html#power-users">Power Users</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="docs/WorkflowDescription.html">Workflow Description</a></li>
 <li class="toctree-l1"><a class="reference internal" href="docs/Restoration_Plan_Config_File.html">Restoration Plan</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="docs/Restoration_Plan_Config_File.html#files">Files</a></li>
@@ -189,16 +202,18 @@ <h1>Welcome to REWET's documentation!<a class="headerlink" href="#welcome-to-rew
 <li class="toctree-l2"><a class="reference internal" href="docs/Future.html#api-development">API Development</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="docs/cite.html">How To Cite</a></li>
 </ul>
 </div>
 <div class="section" id="indices-and-tables">
-<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this heading">¶</a></h2>
+<h3>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this heading">¶</a></h3>
 <ul class="simple">
 <li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
 <li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
 <li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
 </ul>
 </div>
+</div>
 </div>
 
 

diff --git a/doc/_build/html/objects.inv b/doc/_build/html/objects.inv
diff --git a/doc/_build/html/search.html b/doc/_build/html/search.html
@@ -16,6 +16,7 @@
   <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
   <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <link rel="stylesheet" href="_static/tabs.css" type="text/css" />
+  <link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
 
 
 
@@ -98,9 +99,11 @@
               <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="docs/install.html">Install</a></li>
+<li class="toctree-l1"><a class="reference internal" href="docs/inputs.html">Inputs</a></li>
 <li class="toctree-l1"><a class="reference internal" href="docs/WorkflowDescription.html">Workflow Description</a></li>
 <li class="toctree-l1"><a class="reference internal" href="docs/Restoration_Plan_Config_File.html">Restoration Plan</a></li>
 <li class="toctree-l1"><a class="reference internal" href="docs/Future.html">Future Development</a></li>
+<li class="toctree-l1"><a class="reference internal" href="docs/cite.html">How To Cite</a></li>
 </ul>
 
 

diff --git a/doc/_build/html/searchindex.js b/doc/_build/html/searchindex.js
diff --git a/doc/_static/css/custom.css b/doc/_static/css/custom.css
@@ -0,0 +1,3 @@
+.wy-table-responsive table td, .wy-table-responsive table th {
+    white-space: inherit;
+}
diff --git a/doc/conf.py b/doc/conf.py
@@ -27,7 +27,7 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['myst_parser', 'sphinx_tabs.tabs']
+extensions = ['myst_parser', 'sphinx_tabs.tabs', 'sphinx.ext.autosectionlabel']
 source_suffix = {
     '.rst': 'restructuredtext',
 }
@@ -59,4 +59,8 @@
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
-html_logo = "REWET_logo.jpg"
+html_logo = "REWET_logo.jpg"
+
+html_css_files = [
+    'css/custom.css',
+]
-Original file line number
+Diff line change
@@ Expand Up / @@ -3,6 +3,7 @@ MPI_results/ @@
     MPI_results - Copy/
     __pycache__
     Demand Polygons/
+    _build
     *.cpg
     *.dbf
     *.prj
@@ Expand Down @@