deploy: df8f83a

changelog.html

@@ -183,25 +183,26 @@ <h2 id="toc-title">On this page</h2>
   <ul class="collapse">
   <li><a href="#added" id="toc-added" class="nav-link" data-scroll-target="#added"><span class="header-section-number">1.1.1</span> Added</a></li>
   <li><a href="#changed" id="toc-changed" class="nav-link" data-scroll-target="#changed"><span class="header-section-number">1.1.2</span> Changed</a></li>
+  <li><a href="#fixed" id="toc-fixed" class="nav-link" data-scroll-target="#fixed"><span class="header-section-number">1.1.3</span> Fixed</a></li>
   </ul></li>
   <li><a href="#v2024.10.0---2024-07-23" id="toc-v2024.10.0---2024-07-23" class="nav-link" data-scroll-target="#v2024.10.0---2024-07-23"><span class="header-section-number">1.2</span> [v2024.10.0] - 2024-07-23</a>
   <ul class="collapse">
   <li><a href="#added-1" id="toc-added-1" class="nav-link" data-scroll-target="#added-1"><span class="header-section-number">1.2.1</span> Added</a></li>
   <li><a href="#changed-1" id="toc-changed-1" class="nav-link" data-scroll-target="#changed-1"><span class="header-section-number">1.2.2</span> Changed</a></li>
-  <li><a href="#fixed" id="toc-fixed" class="nav-link" data-scroll-target="#fixed"><span class="header-section-number">1.2.3</span> Fixed</a></li>
+  <li><a href="#fixed-1" id="toc-fixed-1" class="nav-link" data-scroll-target="#fixed-1"><span class="header-section-number">1.2.3</span> Fixed</a></li>
   <li><a href="#removed" id="toc-removed" class="nav-link" data-scroll-target="#removed"><span class="header-section-number">1.2.4</span> Removed</a></li>
   </ul></li>
   <li><a href="#v2024.9.0---2024-06-20" id="toc-v2024.9.0---2024-06-20" class="nav-link" data-scroll-target="#v2024.9.0---2024-06-20"><span class="header-section-number">1.3</span> [v2024.9.0] - 2024-06-20</a>
   <ul class="collapse">
   <li><a href="#added-2" id="toc-added-2" class="nav-link" data-scroll-target="#added-2"><span class="header-section-number">1.3.1</span> Added</a></li>
   <li><a href="#changed-2" id="toc-changed-2" class="nav-link" data-scroll-target="#changed-2"><span class="header-section-number">1.3.2</span> Changed</a></li>
-  <li><a href="#fixed-1" id="toc-fixed-1" class="nav-link" data-scroll-target="#fixed-1"><span class="header-section-number">1.3.3</span> Fixed</a></li>
+  <li><a href="#fixed-2" id="toc-fixed-2" class="nav-link" data-scroll-target="#fixed-2"><span class="header-section-number">1.3.3</span> Fixed</a></li>
   </ul></li>
   <li><a href="#v2024.8.0---2024-05-14" id="toc-v2024.8.0---2024-05-14" class="nav-link" data-scroll-target="#v2024.8.0---2024-05-14"><span class="header-section-number">1.4</span> [v2024.8.0] - 2024-05-14</a>
   <ul class="collapse">
   <li><a href="#added-3" id="toc-added-3" class="nav-link" data-scroll-target="#added-3"><span class="header-section-number">1.4.1</span> Added</a></li>
   <li><a href="#changed-3" id="toc-changed-3" class="nav-link" data-scroll-target="#changed-3"><span class="header-section-number">1.4.2</span> Changed</a></li>
-  <li><a href="#fixed-2" id="toc-fixed-2" class="nav-link" data-scroll-target="#fixed-2"><span class="header-section-number">1.4.3</span> Fixed</a></li>
+  <li><a href="#fixed-3" id="toc-fixed-3" class="nav-link" data-scroll-target="#fixed-3"><span class="header-section-number">1.4.3</span> Fixed</a></li>
   </ul></li>
   </ul></li>
   </ul>
@@ -220,9 +221,48 @@ <h1 data-number="1"><span class="header-section-number">1</span> Changelog</h1>
 <h2 data-number="1.1" class="anchored" data-anchor-id="unreleased"><span class="header-section-number">1.1</span> [Unreleased]</h2>
 <section id="added" class="level3" data-number="1.1.1">
 <h3 data-number="1.1.1" class="anchored" data-anchor-id="added"><span class="header-section-number">1.1.1</span> Added</h3>
+<ul>
+<li>Support discrete control based on an external concentration condition. <a href="https://github.com/Deltares/Ribasim/pull/1660">#1660</a></li>
+<li>Add <code>results/solver_stats.arrow</code> with solver statistics over time. <a href="https://github.com/Deltares/Ribasim/pull/1677">#1677</a></li>
+<li>Add icon to <code>ribasim.exe</code> on Windows. <a href="https://github.com/Deltares/Ribasim/pull/1712">#1712</a></li>
+<li>Save QGIS styling in the model database. <a href="https://github.com/Deltares/Ribasim/pull/1713">#1713</a></li>
+<li>Add Delwaq coupling guide. <a href="https://github.com/Deltares/Ribasim/pull/1619">#1619</a></li>
+<li>Solver speedup due to backtracking relaxation. <a href="https://github.com/Deltares/Ribasim/pull/1761">#1761</a></li>
+<li>Reject adding a duplicate edge in Python. <a href="https://github.com/Deltares/Ribasim/pull/1719">#1719</a></li>
+<li>Support transient UserDemand return factor. <a href="https://github.com/Deltares/Ribasim/pull/1727">#1727</a></li>
+<li>Document the interpolation of input data. <a href="https://github.com/Deltares/Ribasim/pull/1720">#1720</a></li>
+<li>Automate Jacobian sparsity detection. <a href="https://github.com/Deltares/Ribasim/pull/1606">#1606</a></li>
+<li>Support specifying the <code>edge_id</code> as <code>model.edge.add(a, b, edge_id=5)</code>. <a href="https://github.com/Deltares/Ribasim/pull/1737">#1737</a></li>
+<li>Use <a href="https://ribasim.org/">https://ribasim.org/</a> to host our documentation. <a href="https://github.com/Deltares/Ribasim/pull/1736">#1736</a></li>
+<li>Validate geometry types in Python. <a href="https://github.com/Deltares/Ribasim/pull/1760">#1760</a></li>
+<li>Add relationships between tables in QGIS. <a href="https://github.com/Deltares/Ribasim/pull/1755">#1755</a></li>
+<li>Support migrating from older Ribasim versions in Python. <a href="https://github.com/Deltares/Ribasim/pull/1764">#1764</a></li>
+<li>Add quick start guide to docs. <a href="https://github.com/Deltares/Ribasim/pull/1787">#1787</a></li>
+<li>Add <code>min_upstream_level</code> and <code>max_downstream_level</code> to Pump and Outlet. <a href="https://github.com/Deltares/Ribasim/pull/1792">#1792</a></li>
+<li>Add <code>max_downstream_level</code> to TabulatedRatingCurve. <a href="https://github.com/Deltares/Ribasim/pull/1795">#1795</a></li>
+<li>Validate edge connections in Python. <a href="https://github.com/Deltares/Ribasim/pull/1765">#1765</a></li>
+<li>Add low storage reduction factor to ManningResistance. <a href="https://github.com/Deltares/Ribasim/pull/1796">#1796</a></li>
+</ul>
 </section>
 <section id="changed" class="level3" data-number="1.1.2">
 <h3 data-number="1.1.2" class="anchored" data-anchor-id="changed"><span class="header-section-number">1.1.2</span> Changed</h3>
+<ul>
+<li>Make <code>node_id</code> globally unique. <a href="https://github.com/Deltares/Ribasim/pull/1717">#1717</a></li>
+<li>Make the Node ID the index of the Node table, and Edge ID for Edge. <a href="https://github.com/Deltares/Ribasim/pull/1737">#1737</a></li>
+<li>Make more Python functions private. <a href="https://github.com/Deltares/Ribasim/pull/1702">#1702</a></li>
+<li>Put the contents of the CLI zips in a folder. <a href="https://github.com/Deltares/Ribasim/pull/1722">#1722</a></li>
+<li>Changed water balance error definition. <a href="https://github.com/Deltares/Ribasim/pull/1767">#1767</a></li>
+<li>Disallow missing priority parameter when using allocation. <a href="https://github.com/Deltares/Ribasim/pull/1745">#1745</a></li>
+<li>Rename Outlet’s <code>min_crest_level</code> to <code>min_upstream_level</code>. <a href="https://github.com/Deltares/Ribasim/pull/1788">#1788</a></li>
+<li>Only allow flow under gravity in TabulatedRatingCurve. <a href="https://github.com/Deltares/Ribasim/pull/1795">#1795</a></li>
+</ul>
+</section>
+<section id="fixed" class="level3" data-number="1.1.3">
+<h3 data-number="1.1.3" class="anchored" data-anchor-id="fixed"><span class="header-section-number">1.1.3</span> Fixed</h3>
+<ul>
+<li>Remove oscillations in ManningResistance. <a href="https://github.com/Deltares/Ribasim/pull/1750">#1750</a></li>
+<li>Fix GeoPandas CRS warning. <a href="https://github.com/Deltares/Ribasim/pull/1810">#1810</a></li>
+</ul>
 </section>
 </section>
 <section id="v2024.10.0---2024-07-23" class="level2" data-number="1.2">
@@ -248,8 +288,8 @@ <h3 data-number="1.2.2" class="anchored" data-anchor-id="changed-1"><span class=
 <li>Require QGIS 3.34 (LTR) or newer for Ribasim QGIS plugin.</li>
 </ul>
 </section>
-<section id="fixed" class="level3" data-number="1.2.3">
-<h3 data-number="1.2.3" class="anchored" data-anchor-id="fixed"><span class="header-section-number">1.2.3</span> Fixed</h3>
+<section id="fixed-1" class="level3" data-number="1.2.3">
+<h3 data-number="1.2.3" class="anchored" data-anchor-id="fixed-1"><span class="header-section-number">1.2.3</span> Fixed</h3>
 <ul>
 <li>Compatibility with latest NumPy, Pandera and PyArrow releases. #1618</li>
 <li>LevelDemand can now be without <code>min_level</code> or <code>max_level</code>. #1629</li>
@@ -283,8 +323,8 @@ <h3 data-number="1.3.2" class="anchored" data-anchor-id="changed-2"><span class=
 <li>Allocation objective function now gives equal ratios during shortage. #1386</li>
 </ul>
 </section>
-<section id="fixed-1" class="level3" data-number="1.3.3">
-<h3 data-number="1.3.3" class="anchored" data-anchor-id="fixed-1"><span class="header-section-number">1.3.3</span> Fixed</h3>
+<section id="fixed-2" class="level3" data-number="1.3.3">
+<h3 data-number="1.3.3" class="anchored" data-anchor-id="fixed-2"><span class="header-section-number">1.3.3</span> Fixed</h3>
 <ul>
 <li>Don’t require unique node IDs. #1513</li>
 <li>Fix QGIS crash on plugin initialization. #1580</li>
@@ -307,8 +347,8 @@ <h3 data-number="1.4.2" class="anchored" data-anchor-id="changed-3"><span class=
 <li>Users of the QGIS plugin need to remove the old version to avoid two copies due to #1453.</li>
 </ul>
 </section>
-<section id="fixed-2" class="level3" data-number="1.4.3">
-<h3 data-number="1.4.3" class="anchored" data-anchor-id="fixed-2"><span class="header-section-number">1.4.3</span> Fixed</h3>
+<section id="fixed-3" class="level3" data-number="1.4.3">
+<h3 data-number="1.4.3" class="anchored" data-anchor-id="fixed-3"><span class="header-section-number">1.4.3</span> Fixed</h3>
 <ul>
 <li>Performance improvements have been a focus of this release, giving up to 10x faster runs. #1433, #1436, #1438, #1448, #1457</li>
 <li>The CLI exe is now always in the root of the zip and makes use of the libribasim shared library. #1415</li>

concept/allocation.html

@@ -574,7 +574,7 @@ <h2 data-number="4.3" class="anchored" data-anchor-id="the-optimization-constrai
 <section id="example" class="level2" data-number="4.4">
 <h2 data-number="4.4" class="anchored" data-anchor-id="example"><span class="header-section-number">4.4</span> Example</h2>
 <p>The following is an example of an optimization problem for the example shown <a href="../guide/examples.html#model-with-allocation-user-demand">here</a>:</p>
-<div id="8b671cb6" class="cell" data-execution_count="1">
+<div id="f71f90eb" class="cell" data-execution_count="1">
 <details class="code-fold">
 <summary>Code</summary>
 <div class="sourceCode cell-code" id="cb1"><pre class="sourceCode julia code-with-copy"><code class="sourceCode julia"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="im">using</span> <span class="bu">Ribasim</span></span>
@@ -597,27 +597,27 @@ <h2 data-number="4.4" class="anchored" data-anchor-id="example"><span class="hea
 <span id="cb1-18"><a href="#cb1-18" aria-hidden="true" tabindex="-1"></a><span class="fu">println</span>(p.allocation.allocation_models[<span class="fl">1</span>].problem)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
 </details>
 <div class="cell-output cell-output-stdout">
-<pre><code>Min F[(Basin #5, UserDemand #6)]² + F[(Basin #2, UserDemand #3)]²
+<pre><code>Min F[(Basin #2, UserDemand #3)]² + F[(Basin #5, UserDemand #6)]²
 Subject to
  flow_conservation[Terminal #8] : F[(TabulatedRatingCurve #7, Terminal #8)] = 0
- flow_conservation[Basin #2] : F[(FlowBoundary #1, Basin #2)] - F[(Basin #2, UserDemand #3)] + F[(UserDemand #3, Basin #2)] - F[(Basin #2, LinearResistance #4)] + F[(LinearResistance #4, Basin #2)] = 0
- flow_conservation[LinearResistance #4] : F[(Basin #2, LinearResistance #4)] - F[(LinearResistance #4, Basin #2)] - F[(LinearResistance #4, Basin #5)] + F[(Basin #5, LinearResistance #4)] = 0
- flow_conservation[Basin #5] : -F[(Basin #5, UserDemand #6)] + F[(LinearResistance #4, Basin #5)] - F[(Basin #5, LinearResistance #4)] - F[(Basin #5, TabulatedRatingCurve #7)] + F[(UserDemand #6, Basin #5)] = 0
+ flow_conservation[Basin #5] : F[(UserDemand #6, Basin #5)] - F[(Basin #5, UserDemand #6)] - F[(Basin #5, TabulatedRatingCurve #7)] + F[(LinearResistance #4, Basin #5)] - F[(Basin #5, LinearResistance #4)] = 0
+ flow_conservation[LinearResistance #4] : -F[(LinearResistance #4, Basin #5)] + F[(Basin #5, LinearResistance #4)] + F[(Basin #2, LinearResistance #4)] - F[(LinearResistance #4, Basin #2)] = 0
+ flow_conservation[Basin #2] : F[(UserDemand #3, Basin #2)] + F[(FlowBoundary #1, Basin #2)] - F[(Basin #2, UserDemand #3)] - F[(Basin #2, LinearResistance #4)] + F[(LinearResistance #4, Basin #2)] = 0
  flow_conservation[TabulatedRatingCurve #7] : F[(Basin #5, TabulatedRatingCurve #7)] - F[(TabulatedRatingCurve #7, Terminal #8)] = 0
  source[(FlowBoundary #1, Basin #2)] : F[(FlowBoundary #1, Basin #2)] ≤ 172800
- source_user[UserDemand #3] : F[(UserDemand #3, Basin #2)] ≤ 0
  source_user[UserDemand #6] : F[(UserDemand #6, Basin #5)] ≤ 0
- F[(Basin #5, UserDemand #6)] ≥ 0
+ source_user[UserDemand #3] : F[(UserDemand #3, Basin #2)] ≤ 0
+ F[(UserDemand #6, Basin #5)] ≥ 0
+ F[(UserDemand #3, Basin #2)] ≥ 0
  F[(FlowBoundary #1, Basin #2)] ≥ 0
  F[(Basin #2, UserDemand #3)] ≥ 0
- F[(UserDemand #3, Basin #2)] ≥ 0
- F[(Basin #2, LinearResistance #4)] ≥ 0
- F[(LinearResistance #4, Basin #2)] ≥ 0
- F[(LinearResistance #4, Basin #5)] ≥ 0
- F[(Basin #5, LinearResistance #4)] ≥ 0
+ F[(Basin #5, UserDemand #6)] ≥ 0
  F[(Basin #5, TabulatedRatingCurve #7)] ≥ 0
  F[(TabulatedRatingCurve #7, Terminal #8)] ≥ 0
- F[(UserDemand #6, Basin #5)] ≥ 0
+ F[(LinearResistance #4, Basin #5)] ≥ 0
+ F[(Basin #5, LinearResistance #4)] ≥ 0
+ F[(Basin #2, LinearResistance #4)] ≥ 0
+ F[(LinearResistance #4, Basin #2)] ≥ 0
 </code></pre>
 </div>
 </div>

reference/node/discrete-control.html

@@ -379,7 +379,7 @@ <h1 class="title">DiscreteControl</h1>
 
 
 <p>Set parameters of other nodes based on model state conditions (e.g.&nbsp;Basin level). The table below shows which parameters are controllable for a given node type.</p>
-<div id="7d6c4e73" class="cell" data-execution_count="1">
+<div id="4cb6714c" class="cell" data-execution_count="1">
 <details class="code-fold">
 <summary>Code</summary>
 <div class="sourceCode cell-code" id="cb1"><pre class="sourceCode julia code-with-copy"><code class="sourceCode julia"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="im">using</span> <span class="bu">Ribasim</span></span>

reference/node/manning-resistance.html

@@ -535,7 +535,7 @@ <h1 data-number="2"><span class="header-section-number">2</span> Equations</h1>
   \end{cases}
 \end{align}
 \]</span></p>
-<div id="19244038" class="cell" data-execution_count="1">
+<div id="b52dea28" class="cell" data-execution_count="1">
 <details class="code-fold">
 <summary>Code</summary>
 <div class="sourceCode cell-code" id="cb1"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="im">import</span> numpy <span class="im">as</span> np</span>

reference/node/tabulated-rating-curve.html

@@ -476,7 +476,7 @@ <h2 data-number="1.1" class="anchored" data-anchor-id="static"><span class="head
 <section id="interpolation" class="level3" data-number="1.1.1">
 <h3 data-number="1.1.1" class="anchored" data-anchor-id="interpolation"><span class="header-section-number">1.1.1</span> Interpolation</h3>
 <p>The <span class="math inline">\(Q(h)\)</span> relationship of a tabulated rating curve is defined as a linear interpolation.</p>
-<div id="25c76780" class="cell" data-execution_count="1">
+<div id="d670d37f" class="cell" data-execution_count="1">
 <details class="code-fold">
 <summary>Code</summary>
 <div class="sourceCode cell-code" id="cb1"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="im">import</span> numpy <span class="im">as</span> np</span>

reference/test-models.html

@@ -339,7 +339,7 @@ <h1 class="title">Test models</h1>
 
 
 <p>Ribasim developers use the following models in their testbench and in order to test new features.</p>
-<div id="7a6c5728" class="cell" data-execution_count="1">
+<div id="c02cff90" class="cell" data-execution_count="1">
 <details class="code-fold">
 <summary>Code</summary>
 <div class="sourceCode cell-code" id="cb1"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="im">import</span> ribasim_testmodels</span>

reference/validation.html

@@ -349,7 +349,7 @@ <h1 class="title">Validation</h1>
 <section id="connectivity" class="level1" data-number="1">
 <h1 data-number="1"><span class="header-section-number">1</span> Connectivity</h1>
 <p>In the table below, each column shows which node types are allowed to be downstream (or ‘down-control’) of the node type at the top of the column.</p>
-<div id="33b685c7" class="cell" data-execution_count="1">
+<div id="43ac97a3" class="cell" data-execution_count="1">
 <details class="code-fold">
 <summary>Code</summary>
 <div class="sourceCode cell-code" id="cb1"><pre class="sourceCode julia code-with-copy"><code class="sourceCode julia"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="im">using</span> <span class="bu">Ribasim</span></span>
@@ -699,7 +699,7 @@ <h1 data-number="1"><span class="header-section-number">1</span> Connectivity</h
 <section id="neighbor-amounts" class="level1" data-number="2">
 <h1 data-number="2"><span class="header-section-number">2</span> Neighbor amounts</h1>
 <p>The table below shows for each node type between which bounds the amount of in- and outneighbors must be, for both flow and control edges.</p>
-<div id="49bcd759" class="cell" data-execution_count="2">
+<div id="9c184216" class="cell" data-execution_count="2">
 <details class="code-fold">
 <summary>Code</summary>
 <div class="sourceCode cell-code" id="cb2"><pre class="sourceCode julia code-with-copy"><code class="sourceCode julia"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a>flow_in_min <span class="op">=</span> <span class="fu">Vector</span><span class="dt">{String}</span>()</span>