Built site for gh-pages

Deltares · Aug 17, 2023 · 279e071 · 279e071
1 parent 920de8c
commit 279e071
Show file tree

Hide file tree

Showing 11 changed files with 156 additions and 156 deletions.
diff --git a/.nojekyll b/.nojekyll
@@ -1 +1 @@
-8517287e
+235bed38
diff --git a/build/index.html b/build/index.html
diff --git a/contribute/addnode.html b/contribute/addnode.html
@@ -279,7 +279,7 @@ <h2 data-number="1.2" class="anchored" data-anchor-id="reading-from-configuratio
 <span id="cb3-2"><a href="#cb3-2" aria-hidden="true" tabindex="-1"></a>    static <span class="op">=</span> <span class="fu">load_structvector</span>(db, config, NewNodeTypeStaticV1)</span>
 <span id="cb3-3"><a href="#cb3-3" aria-hidden="true" tabindex="-1"></a>    defaults <span class="op">=</span> (; active <span class="op">=</span> <span class="cn">true</span>)</span>
 <span id="cb3-4"><a href="#cb3-4" aria-hidden="true" tabindex="-1"></a>    <span class="co"># Process potential control states in the static data</span></span>
-<span id="cb3-5"><a href="#cb3-5" aria-hidden="true" tabindex="-1"></a>    static_parsed <span class="op">=</span> <span class="fu">parse_static</span>(static, db, <span class="st">"Weir"</span>, defaults)</span>
+<span id="cb3-5"><a href="#cb3-5" aria-hidden="true" tabindex="-1"></a>    static_parsed <span class="op">=</span> <span class="fu">parse_static</span>(static, db, <span class="st">"Outlet"</span>, defaults)</span>
 <span id="cb3-6"><a href="#cb3-6" aria-hidden="true" tabindex="-1"></a></span>
 <span id="cb3-7"><a href="#cb3-7" aria-hidden="true" tabindex="-1"></a>    <span class="co"># Unpack the fields of static as inputs for the NewNodeType constructor</span></span>
 <span id="cb3-8"><a href="#cb3-8" aria-hidden="true" tabindex="-1"></a>    <span class="cf">return</span> <span class="fu">NewNodeType</span>(</span>

diff --git a/core/equations.html b/core/equations.html
diff --git a/core/usage.html b/core/usage.html
@@ -219,7 +219,7 @@ <h2 id="toc-title">On this page</h2>
   <li><a href="#fractionalflow" id="toc-fractionalflow" class="nav-link" data-scroll-target="#fractionalflow"><span class="header-section-number">1.9</span> FractionalFlow</a></li>
   <li><a href="#tabulatedratingcurve" id="toc-tabulatedratingcurve" class="nav-link" data-scroll-target="#tabulatedratingcurve"><span class="header-section-number">1.10</span> TabulatedRatingCurve</a></li>
   <li><a href="#tabulatedratingcurve-time" id="toc-tabulatedratingcurve-time" class="nav-link" data-scroll-target="#tabulatedratingcurve-time"><span class="header-section-number">1.11</span> TabulatedRatingCurve / time</a></li>
-  <li><a href="#pump-and-weir" id="toc-pump-and-weir" class="nav-link" data-scroll-target="#pump-and-weir"><span class="header-section-number">1.12</span> Pump and weir</a></li>
+  <li><a href="#pump-and-outlet" id="toc-pump-and-outlet" class="nav-link" data-scroll-target="#pump-and-outlet"><span class="header-section-number">1.12</span> Pump and outlet</a></li>
   <li><a href="#levelboundary" id="toc-levelboundary" class="nav-link" data-scroll-target="#levelboundary"><span class="header-section-number">1.13</span> LevelBoundary</a></li>
   <li><a href="#flowboundary" id="toc-flowboundary" class="nav-link" data-scroll-target="#flowboundary"><span class="header-section-number">1.14</span> FlowBoundary</a></li>
   <li><a href="#flowboundary-time" id="toc-flowboundary-time" class="nav-link" data-scroll-target="#flowboundary-time"><span class="header-section-number">1.15</span> FlowBoundary / time</a></li>
@@ -415,7 +415,7 @@ <h3 data-number="1.3" class="anchored" data-anchor-id="node"><span class="header
 <li><code>DisceteControl / condition</code>: Conditions of the form ‘the level in the basin with node id <code>n</code> is bigger than 2.0 m’</li>
 <li><code>DisceteControl / logic</code>: Translates the truth value of a set of conditions to parameter values for a controlled node</li>
 </ul></li>
-<li>PidControl: Controls the level in a basin by continuously controlling the flow rate of a connected pump or weir. See also <a href="https://en.wikipedia.org/wiki/PID_controller">Wikipedia</a> and <a href="../core/equations.html#sec-PID">PID controller in equations</a>.
+<li>PidControl: Controls the level in a basin by continuously controlling the flow rate of a connected pump or outlet. See also <a href="https://en.wikipedia.org/wiki/PID_controller">Wikipedia</a> and <a href="../core/equations.html#sec-PID">PID controller in equations</a>.
 <ul>
 <li><code>PidControl / static</code>: The proportional, integral and derivative parameters and which basin should be controlled.</li>
 </ul></li>
@@ -782,8 +782,8 @@ <h3 data-number="1.11" class="anchored" data-anchor-id="tabulatedratingcurve-tim
 </tbody>
 </table>
 </section>
-<section id="pump-and-weir" class="level3" data-number="1.12">
-<h3 data-number="1.12" class="anchored" data-anchor-id="pump-and-weir"><span class="header-section-number">1.12</span> Pump and weir</h3>
+<section id="pump-and-outlet" class="level3" data-number="1.12">
+<h3 data-number="1.12" class="anchored" data-anchor-id="pump-and-outlet"><span class="header-section-number">1.12</span> Pump and outlet</h3>
 <p>Pump/conduct water from a source node to a destination node. The set flow rate will be pumped unless the intake storage is less than <span class="math inline">\(10~m^3\)</span>, in which case the flow rate will be linearly reduced to <span class="math inline">\(0~m^3/s\)</span>. The intake must be either a Basin or LevelBoundary.</p>
 <table class="table">
 <colgroup>
@@ -1268,8 +1268,8 @@ <h4 data-number="1.21.3" class="anchored" data-anchor-id="discretecontrol-output
 </section>
 <section id="pidcontrol" class="level3" data-number="1.22">
 <h3 data-number="1.22" class="anchored" data-anchor-id="pidcontrol"><span class="header-section-number">1.22</span> PidControl</h3>
-<p>The PidControl node controls the level in a basin by continuously controlling the flow rate of a connected pump or weir. See also <a href="https://en.wikipedia.org/wiki/PID_controller">PID controller</a>. When A PidControl node is made inactive, the node under its control retains the last flow rate value, and the error integral is reset to 0. For computational efficiency, if one of the terms should not be used, set its coefficient to <code>NaN</code> in stead of <span class="math inline">\(0\)</span>.</p>
-<p>The pump must be an outneighbor of the controlled basin, the weir must be an inneighbor. Thus for the same coefficient values in <code>proportional</code>, <code>integral</code> and <code>derivative</code>, the pump and weir have the oppositve effect on the controlled basin.</p>
+<p>The PidControl node controls the level in a basin by continuously controlling the flow rate of a connected pump or outlet. See also <a href="https://en.wikipedia.org/wiki/PID_controller">PID controller</a>. When A PidControl node is made inactive, the node under its control retains the last flow rate value, and the error integral is reset to 0. For computational efficiency, if one of the terms should not be used, set its coefficient to <code>NaN</code> in stead of <span class="math inline">\(0\)</span>.</p>
+<p>The pump must be an outneighbor of the controlled basin, the outlet must be an inneighbor. Thus for the same coefficient values in <code>proportional</code>, <code>integral</code> and <code>derivative</code>, the pump and outlet have the oppositve effect on the controlled basin.</p>
 <p>In the future controlling the flow on a particular edge could be supported.</p>
 <table class="table">
 <thead>

diff --git a/python/examples.html b/python/examples.html
@@ -562,7 +562,7 @@ <h1 data-number="2"><span class="header-section-number">2</span> Update the basi
 <span id="cb28-4"><a href="#cb28-4" aria-hidden="true" tabindex="-1"></a>ax <span class="op">=</span> df_flow.pivot_table(index<span class="op">=</span><span class="st">"time"</span>, columns<span class="op">=</span><span class="st">"edge"</span>, values<span class="op">=</span><span class="st">"flow_m3d"</span>).plot()</span>
 <span id="cb28-5"><a href="#cb28-5" aria-hidden="true" tabindex="-1"></a>ax.legend(bbox_to_anchor<span class="op">=</span>(<span class="fl">1.3</span>, <span class="dv">1</span>), title<span class="op">=</span><span class="st">"Edge"</span>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
 <div class="cell-output cell-output-display" data-execution_count="26">
-<pre><code>&lt;matplotlib.legend.Legend at 0x7f2cea5c9750&gt;</code></pre>
+<pre><code>&lt;matplotlib.legend.Legend at 0x7ff144c2bed0&gt;</code></pre>
 </div>
 <div class="cell-output cell-output-display">
 <p><img src="examples_files/figure-html/cell-27-output-2.png" width="727" height="412"></p>
@@ -868,7 +868,7 @@ <h1 data-number="4"><span class="header-section-number">4</span> Model with PID
 <span id="cb48-5"><a href="#cb48-5" aria-hidden="true" tabindex="-1"></a>        (<span class="fl">2.0</span>, <span class="fl">0.5</span>),  <span class="co"># 3: Pump</span></span>
 <span id="cb48-6"><a href="#cb48-6" aria-hidden="true" tabindex="-1"></a>        (<span class="fl">3.0</span>, <span class="fl">0.0</span>),  <span class="co"># 4: LevelBoundary</span></span>
 <span id="cb48-7"><a href="#cb48-7" aria-hidden="true" tabindex="-1"></a>        (<span class="fl">1.5</span>, <span class="fl">1.0</span>),  <span class="co"># 5: PidControl</span></span>
-<span id="cb48-8"><a href="#cb48-8" aria-hidden="true" tabindex="-1"></a>        (<span class="fl">2.0</span>, <span class="op">-</span><span class="fl">0.5</span>),  <span class="co"># 6: Weir</span></span>
+<span id="cb48-8"><a href="#cb48-8" aria-hidden="true" tabindex="-1"></a>        (<span class="fl">2.0</span>, <span class="op">-</span><span class="fl">0.5</span>),  <span class="co"># 6: outlet</span></span>
 <span id="cb48-9"><a href="#cb48-9" aria-hidden="true" tabindex="-1"></a>        (<span class="fl">1.5</span>, <span class="op">-</span><span class="fl">1.0</span>),  <span class="co"># 7: PidControl</span></span>
 <span id="cb48-10"><a href="#cb48-10" aria-hidden="true" tabindex="-1"></a>    ]</span>
 <span id="cb48-11"><a href="#cb48-11" aria-hidden="true" tabindex="-1"></a>)</span>
@@ -881,7 +881,7 @@ <h1 data-number="4"><span class="header-section-number">4</span> Model with PID
 <span id="cb48-18"><a href="#cb48-18" aria-hidden="true" tabindex="-1"></a>    <span class="st">"Pump"</span>,</span>
 <span id="cb48-19"><a href="#cb48-19" aria-hidden="true" tabindex="-1"></a>    <span class="st">"LevelBoundary"</span>,</span>
 <span id="cb48-20"><a href="#cb48-20" aria-hidden="true" tabindex="-1"></a>    <span class="st">"PidControl"</span>,</span>
-<span id="cb48-21"><a href="#cb48-21" aria-hidden="true" tabindex="-1"></a>    <span class="st">"Weir"</span>,</span>
+<span id="cb48-21"><a href="#cb48-21" aria-hidden="true" tabindex="-1"></a>    <span class="st">"Outlet"</span>,</span>
 <span id="cb48-22"><a href="#cb48-22" aria-hidden="true" tabindex="-1"></a>    <span class="st">"PidControl"</span>,</span>
 <span id="cb48-23"><a href="#cb48-23" aria-hidden="true" tabindex="-1"></a>]</span>
 <span id="cb48-24"><a href="#cb48-24" aria-hidden="true" tabindex="-1"></a></span>
@@ -950,9 +950,9 @@ <h1 data-number="4"><span class="header-section-number">4</span> Model with PID
 <span id="cb51-7"><a href="#cb51-7" aria-hidden="true" tabindex="-1"></a>    )</span>
 <span id="cb51-8"><a href="#cb51-8" aria-hidden="true" tabindex="-1"></a>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
 </div>
-<p>Setup the weir:</p>
+<p>Setup the outlet:</p>
 <div class="cell" data-execution_count="46">
-<div class="sourceCode cell-code" id="cb52"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb52-1"><a href="#cb52-1" aria-hidden="true" tabindex="-1"></a>weir <span class="op">=</span> ribasim.Weir(</span>
+<div class="sourceCode cell-code" id="cb52"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb52-1"><a href="#cb52-1" aria-hidden="true" tabindex="-1"></a>outlet <span class="op">=</span> ribasim.Outlet(</span>
 <span id="cb52-2"><a href="#cb52-2" aria-hidden="true" tabindex="-1"></a>    static<span class="op">=</span>pd.DataFrame(</span>
 <span id="cb52-3"><a href="#cb52-3" aria-hidden="true" tabindex="-1"></a>        data<span class="op">=</span>{</span>
 <span id="cb52-4"><a href="#cb52-4" aria-hidden="true" tabindex="-1"></a>            <span class="st">"node_id"</span>: [<span class="dv">6</span>],</span>
@@ -992,7 +992,7 @@ <h1 data-number="4"><span class="header-section-number">4</span> Model with PID
 <span id="cb55-10"><a href="#cb55-10" aria-hidden="true" tabindex="-1"></a>    )</span>
 <span id="cb55-11"><a href="#cb55-11" aria-hidden="true" tabindex="-1"></a>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
 </div>
-<p>Note that the coefficients for the pump and the weir are equal in magnitude but opposite in sign. This way the pump and the weir equally work towards the same goal, while having opposite effects on the controlled basin due to their connectivity to this basin.</p>
+<p>Note that the coefficients for the pump and the outlet are equal in magnitude but opposite in sign. This way the pump and the outlet equally work towards the same goal, while having opposite effects on the controlled basin due to their connectivity to this basin.</p>
 <p>Setup a model:</p>
 <div class="cell" data-execution_count="50">
 <div class="sourceCode cell-code" id="cb56"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb56-1"><a href="#cb56-1" aria-hidden="true" tabindex="-1"></a>model <span class="op">=</span> ribasim.Model(</span>
@@ -1003,7 +1003,7 @@ <h1 data-number="4"><span class="header-section-number">4</span> Model with PID
 <span id="cb56-6"><a href="#cb56-6" aria-hidden="true" tabindex="-1"></a>    flow_boundary<span class="op">=</span>flow_boundary,</span>
 <span id="cb56-7"><a href="#cb56-7" aria-hidden="true" tabindex="-1"></a>    level_boundary<span class="op">=</span>level_boundary,</span>
 <span id="cb56-8"><a href="#cb56-8" aria-hidden="true" tabindex="-1"></a>    pump<span class="op">=</span>pump,</span>
-<span id="cb56-9"><a href="#cb56-9" aria-hidden="true" tabindex="-1"></a>    weir<span class="op">=</span>weir,</span>
+<span id="cb56-9"><a href="#cb56-9" aria-hidden="true" tabindex="-1"></a>    outlet<span class="op">=</span>outlet,</span>
 <span id="cb56-10"><a href="#cb56-10" aria-hidden="true" tabindex="-1"></a>    pid_control<span class="op">=</span>pid_control,</span>
 <span id="cb56-11"><a href="#cb56-11" aria-hidden="true" tabindex="-1"></a>    starttime<span class="op">=</span><span class="st">"2020-01-01 00:00:00"</span>,</span>
 <span id="cb56-12"><a href="#cb56-12" aria-hidden="true" tabindex="-1"></a>    endtime<span class="op">=</span><span class="st">"2020-07-01 00:00:00"</span>,</span>

diff --git a/python/examples_files/figure-html/cell-52-output-2.png b/python/examples_files/figure-html/cell-52-output-2.png
diff --git a/python/reference/Model.html b/python/reference/Model.html
@@ -244,8 +244,8 @@ <h2 data-number="1.1" class="anchored" data-anchor-id="parameters"><span class="
 <td><em>required</em></td>
 </tr>
 <tr class="even">
-<td><code>weir</code></td>
-<td>typing.Optional[ribasim.node_types.weir.Weir]</td>
+<td><code>outlet</code></td>
+<td>typing.Optional[ribasim.node_types.outlet.Outlet]</td>
 <td>Prescribed flow rate from one basin to the other.</td>
 <td><em>required</em></td>
 </tr>
@@ -264,7 +264,7 @@ <h2 data-number="1.1" class="anchored" data-anchor-id="parameters"><span class="
 <tr class="odd">
 <td><code>pid_control</code></td>
 <td>typing.Optional[ribasim.node_types.pid_control.PidControl]</td>
-<td>PID controller attempting to set the level of a basin to a desired value using a pump/weir.</td>
+<td>PID controller attempting to set the level of a basin to a desired value using a pump/outlet.</td>
 <td><em>required</em></td>
 </tr>
 <tr class="even">

diff --git a/schema/WeirStatic.schema.json → schema/OutletStatic.schema.json b/schema/WeirStatic.schema.json → schema/OutletStatic.schema.json
@@ -50,8 +50,8 @@
         "node_id",
         "flow_rate"
     ],
-    "$id": "https://deltares.github.io/Ribasim/schema/WeirStatic.schema.json",
-    "title": "WeirStatic",
-    "description": "A WeirStatic object based on Ribasim.WeirStaticV1",
+    "$id": "https://deltares.github.io/Ribasim/schema/OutletStatic.schema.json",
+    "title": "OutletStatic",
+    "description": "A OutletStatic object based on Ribasim.OutletStaticV1",
     "type": "object"
 }
diff --git a/schema/root.schema.json b/schema/root.schema.json
@@ -13,9 +13,6 @@
         "PumpStatic": {
             "$ref": "PumpStatic.schema.json"
         },
-        "WeirStatic": {
-            "$ref": "WeirStatic.schema.json"
-        },
         "LevelBoundaryStatic": {
             "$ref": "LevelBoundaryStatic.schema.json"
         },
@@ -40,6 +37,9 @@
         "FlowBoundaryStatic": {
             "$ref": "FlowBoundaryStatic.schema.json"
         },
+        "OutletStatic": {
+            "$ref": "OutletStatic.schema.json"
+        },
         "Node": {
             "$ref": "Node.schema.json"
         },

diff --git a/search.json b/search.json