Skip to content

Commit

Permalink
deploy: 5b5e99f
Browse files Browse the repository at this point in the history
  • Loading branch information
@SouthEndMusic
SouthEndMusic committed Dec 3, 2024
1 parent bf39e46 commit b2f5468
Show file tree
Hide file tree
Showing 25 changed files with 17,280 additions and 16,882 deletions.
35 changes: 22 additions & 13 deletions changelog.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -189,30 +189,33 @@ <h2 id="toc-title">On this page</h2>
<ul>
<li><a href="#changelog" id="toc-changelog" class="nav-link active" data-scroll-target="#changelog"><span class="header-section-number">1</span> Changelog</a>
<ul class="collapse">
<li><a href="#unreleased" id="toc-unreleased" class="nav-link" data-scroll-target="#unreleased"><span class="header-section-number">1.1</span> [Unreleased]</a></li>
<li><a href="#unreleased" id="toc-unreleased" class="nav-link" data-scroll-target="#unreleased"><span class="header-section-number">1.1</span> [Unreleased]</a>
<ul class="collapse">
<li><a href="#changed" id="toc-changed" class="nav-link" data-scroll-target="#changed"><span class="header-section-number">1.1.1</span> Changed</a></li>
</ul></li>
<li><a href="#v2024.11.0---2024-10-08" id="toc-v2024.11.0---2024-10-08" class="nav-link" data-scroll-target="#v2024.11.0---2024-10-08"><span class="header-section-number">1.2</span> [v2024.11.0] - 2024-10-08</a>
<ul class="collapse">
<li><a href="#added" id="toc-added" class="nav-link" data-scroll-target="#added"><span class="header-section-number">1.2.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.2.2</span> Changed</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>
</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.3</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.3.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.3.2</span> Changed</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="#removed" id="toc-removed" class="nav-link" data-scroll-target="#removed"><span class="header-section-number">1.3.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.4</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.4.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.4.2</span> Changed</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>
</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.5</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.5.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.5.2</span> Changed</a></li>
<li><a href="#changed-4" id="toc-changed-4" class="nav-link" data-scroll-target="#changed-4"><span class="header-section-number">1.5.2</span> Changed</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.5.3</span> Fixed</a></li>
</ul></li>
</ul></li>
Expand All @@ -230,6 +233,12 @@ <h1 data-number="1"><span class="header-section-number">1</span> Changelog</h1>
<p>All notable changes to this project will be documented in this file. The format is based on <a href="https://keepachangelog.com/en/1.1.0/">Keep a Changelog</a>,</p>
<section id="unreleased" class="level2" data-number="1.1">
<h2 data-number="1.1" class="anchored" data-anchor-id="unreleased"><span class="header-section-number">1.1</span> [Unreleased]</h2>
<section id="changed" class="level3" data-number="1.1.1">
<h3 data-number="1.1.1" class="anchored" data-anchor-id="changed"><span class="header-section-number">1.1.1</span> Changed</h3>
<ul>
<li>The Edge table no longer supports <code>subnetwork_id</code>; this is automatically inferred. <a href="https://github.com/Deltares/Ribasim/pull/1956">#1956</a></li>
</ul>
</section>
</section>
<section id="v2024.11.0---2024-10-08" class="level2" data-number="1.2">
<h2 data-number="1.2" class="anchored" data-anchor-id="v2024.11.0---2024-10-08"><span class="header-section-number">1.2</span> [v2024.11.0] - 2024-10-08</h2>
Expand Down Expand Up @@ -261,8 +270,8 @@ <h3 data-number="1.2.1" class="anchored" data-anchor-id="added"><span class="hea
<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.2.2">
<h3 data-number="1.2.2" class="anchored" data-anchor-id="changed"><span class="header-section-number">1.2.2</span> Changed</h3>
<section id="changed-1" class="level3" data-number="1.2.2">
<h3 data-number="1.2.2" class="anchored" data-anchor-id="changed-1"><span class="header-section-number">1.2.2</span> Changed</h3>
<ul>
<li>Refactor of the core to ensure smaller water balance errors. <a href="https://github.com/Deltares/Ribasim/pull/1819">#1819</a></li>
<li>Make <code>node_id</code> globally unique. <a href="https://github.com/Deltares/Ribasim/pull/1717">#1717</a></li>
Expand Down Expand Up @@ -301,8 +310,8 @@ <h3 data-number="1.3.1" class="anchored" data-anchor-id="added-1"><span class="h
<li>Also write stacktraces to <code>ribasim.log</code>. <a href="https://github.com/Deltares/Ribasim/pull/1653">#1653</a></li>
</ul>
</section>
<section id="changed-1" class="level3" data-number="1.3.2">
<h3 data-number="1.3.2" class="anchored" data-anchor-id="changed-1"><span class="header-section-number">1.3.2</span> Changed</h3>
<section id="changed-2" class="level3" data-number="1.3.2">
<h3 data-number="1.3.2" class="anchored" data-anchor-id="changed-2"><span class="header-section-number">1.3.2</span> Changed</h3>
<ul>
<li>Require QGIS 3.34 (LTR) or newer for Ribasim QGIS plugin.</li>
</ul>
Expand Down Expand Up @@ -332,8 +341,8 @@ <h3 data-number="1.4.1" class="anchored" data-anchor-id="added-2"><span class="h
<li>Show exact commit on <code>ribasim --version</code> if it is not a release. <a href="https://github.com/Deltares/Ribasim/pull/1479">#1479</a></li>
</ul>
</section>
<section id="changed-2" class="level3" data-number="1.4.2">
<h3 data-number="1.4.2" class="anchored" data-anchor-id="changed-2"><span class="header-section-number">1.4.2</span> Changed</h3>
<section id="changed-3" class="level3" data-number="1.4.2">
<h3 data-number="1.4.2" class="anchored" data-anchor-id="changed-3"><span class="header-section-number">1.4.2</span> Changed</h3>
<ul>
<li>Optimized performance.</li>
<li>Documentation has been overhauled to be more user-friendly.</li>
Expand All @@ -359,8 +368,8 @@ <h3 data-number="1.5.1" class="anchored" data-anchor-id="added-3"><span class="h
<li>If the model does not converge and the used algorithm supports it, we log which Basins don’t converge. <a href="https://github.com/Deltares/Ribasim/pull/1440">#1440</a></li>
</ul>
</section>
<section id="changed-3" class="level3" data-number="1.5.2">
<h3 data-number="1.5.2" class="anchored" data-anchor-id="changed-3"><span class="header-section-number">1.5.2</span> Changed</h3>
<section id="changed-4" class="level3" data-number="1.5.2">
<h3 data-number="1.5.2" class="anchored" data-anchor-id="changed-4"><span class="header-section-number">1.5.2</span> Changed</h3>
<ul>
<li>If negative storages inadvertently happen, we now throw an error. <a href="https://github.com/Deltares/Ribasim/pull/1425">#1425</a></li>
<li>Users of the QGIS plugin need to remove the old version to avoid two copies due to <a href="https://github.com/Deltares/Ribasim/pull/1453">#1453</a>.</li>
Expand Down
28 changes: 14 additions & 14 deletions concept/allocation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -377,8 +377,8 @@ <h3 data-number="3.1.1" class="anchored" data-anchor-id="the-subnetwork"><span c
<section id="source-flows" class="level3" data-number="3.1.2">
<h3 data-number="3.1.2" class="anchored" data-anchor-id="source-flows"><span class="header-section-number">3.1.2</span> Source flows</h3>
<p>Sources are indicated by a set of edges in the subnetwork <span class="math display">\[
E_S^\text{source} \subset E.
\]</span> That is, if <span class="math inline">\((i,j) \in E_S^\text{source}\)</span>, then the average over the last allocation interval <span class="math inline">\(\Delta t_{\text{alloc}}\)</span> of the of the flow over this edge <span class="math display">\[
E_S^\text{source} \subset E,
\]</span> which are automatically inferred as all edges that point out of LevelBoundary or FlowBoundary nodes. That is, if <span class="math inline">\((i,j) \in E_S^\text{source}\)</span>, then the average over the last allocation interval <span class="math inline">\(\Delta t_{\text{alloc}}\)</span> of the of the flow over this edge <span class="math display">\[
\frac{1}{\Delta t_{\text{alloc}}}\int_{t - \Delta t_{\text{alloc}}}^tQ_{ij}(t') dt'
\]</span> is treated as a source flow in the allocation problem. These edges are either coming from a boundary/source node (e.g.&nbsp;a level or flow boundary) or connect the main network to a subnetwork. For the definition of <span class="math inline">\(Q_{ij}\)</span> see <a href="../concept/equations.html#formal-model-description">the formal model description</a>.</p>
</section>
Expand Down Expand Up @@ -577,7 +577,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="e225d9cf" class="cell" data-execution_count="1">
<div id="19f0e029" 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>
Expand All @@ -600,25 +600,25 @@ <h2 data-number="4.4" class="anchored" data-anchor-id="example"><span class="hea
<div class="cell-output cell-output-stdout">
<pre><code>Min F[(Basin #5, UserDemand #6)]² + 0.6666666666666666 F[(Basin #2, UserDemand #3)]² - 2 F[(Basin #2, UserDemand #3)] + 1.5
Subject to
source[(FlowBoundary #1, Basin #2)] : F[(FlowBoundary #1, Basin #2)] ≤ 0
source_boundary[(FlowBoundary #1, Basin #2)] : F[(FlowBoundary #1, Basin #2)] ≤ 0
source_user[UserDemand #3] : F[(UserDemand #3, Basin #2)] ≤ 0
source_user[UserDemand #6] : F[(UserDemand #6, Basin #5)] ≤ 0
F[(LinearResistance #4, Basin #5)] ≥ 0
F[(Basin #5, LinearResistance #4)] ≥ 0
F[(TabulatedRatingCurve #7, Terminal #8)] ≥ 0
F[(FlowBoundary #1, Basin #2)] ≥ 0
F[(Basin #5, UserDemand #6)] ≥ 0
F[(Basin #5, TabulatedRatingCurve #7)] ≥ 0
F[(UserDemand #6, Basin #5)] ≥ 0
F[(Basin #2, UserDemand #3)] ≥ 0
F[(Basin #2, LinearResistance #4)] ≥ 0
F[(LinearResistance #4, Basin #2)] ≥ 0
F[(FlowBoundary #1, Basin #2)] ≥ 0
F[(TabulatedRatingCurve #7, Terminal #8)] ≥ 0
F[(UserDemand #3, Basin #2)] ≥ 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[(Basin #2, UserDemand #3)] - F[(Basin #2, LinearResistance #4)] + F[(LinearResistance #4, Basin #2)] + F[(FlowBoundary #1, Basin #2)] + F[(UserDemand #3, Basin #2)] = 0
flow_conservation[TabulatedRatingCurve #7] : F[(Basin #5, TabulatedRatingCurve #7)] - F[(TabulatedRatingCurve #7, Terminal #8)] = 0
F[(LinearResistance #4, Basin #5)] ≥ 0
F[(Basin #5, LinearResistance #4)] ≥ 0
F[(Basin #5, TabulatedRatingCurve #7)] ≥ 0
F[(Basin #2, UserDemand #3)] ≥ 0
flow_conservation[Basin #5] : -F[(Basin #5, UserDemand #6)] + F[(UserDemand #6, Basin #5)] + F[(LinearResistance #4, Basin #5)] - F[(Basin #5, LinearResistance #4)] - F[(Basin #5, TabulatedRatingCurve #7)] = 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[TabulatedRatingCurve #7] : -F[(TabulatedRatingCurve #7, Terminal #8)] + F[(Basin #5, TabulatedRatingCurve #7)] = 0
flow_conservation[Terminal #8] : F[(TabulatedRatingCurve #7, Terminal #8)] = 0
flow_conservation[Basin #5] : F[(LinearResistance #4, Basin #5)] - F[(Basin #5, LinearResistance #4)] - F[(Basin #5, UserDemand #6)] - F[(Basin #5, TabulatedRatingCurve #7)] + F[(UserDemand #6, Basin #5)] = 0
flow_conservation[Basin #2] : F[(FlowBoundary #1, Basin #2)] - F[(Basin #2, LinearResistance #4)] + F[(LinearResistance #4, Basin #2)] + F[(UserDemand #3, Basin #2)] - F[(Basin #2, UserDemand #3)] = 0
</code></pre>
</div>
</div>
Expand Down
Loading

0 comments on commit b2f5468

Please sign in to comment.