Built site for gh-pages

.nojekyll

@@ -1 +1 @@
-2aeec459
+c7ea71b2

contribute/core.html

@@ -334,7 +334,7 @@ <h2 data-number="2.3" class="anchored" data-anchor-id="run-ribasim-simulations">
 <div class="sourceCode" id="cb11"><pre class="sourceCode julia code-with-copy"><code class="sourceCode julia"><span id="cb11-1"><a href="#cb11-1" aria-hidden="true" tabindex="-1"></a>pkg<span class="op">&gt;</span> activate core</span>
 <span id="cb11-2"><a href="#cb11-2" aria-hidden="true" tabindex="-1"></a>pkg<span class="op">&gt;</span> instantiate</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
 <p>Press backspace to go back to the Julia REPL. There you can run a model with:</p>
-<div class="sourceCode" id="cb12"><pre class="sourceCode julia code-with-copy"><code class="sourceCode julia"><span id="cb12-1"><a href="#cb12-1" aria-hidden="true" tabindex="-1"></a>julia<span class="op">&gt;</span> Ribasim.<span class="fu">run</span>(<span class="st">"path/to/model.toml"</span>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
+<div class="sourceCode" id="cb12"><pre class="sourceCode julia code-with-copy"><code class="sourceCode julia"><span id="cb12-1"><a href="#cb12-1" aria-hidden="true" tabindex="-1"></a>julia<span class="op">&gt;</span> Ribasim.<span class="fu">run</span>(<span class="st">"path/to/model/ribasim.toml"</span>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
 <div class="callout callout-style-default callout-tip callout-titled">
 <div class="callout-header d-flex align-content-center">
 <div class="callout-icon-container">

python/reference/Edge.html

@@ -186,14 +186,14 @@ <h2 data-number="1.2" class="anchored" data-anchor-id="methods"><span class="hea
 <tbody>
 <tr class="odd">
 <td><a href="#ribasim.Edge.write_layer">write_layer</a></td>
-<td>Write the contents of the input to a GeoPackage.</td>
+<td>Write the contents of the input to a database.</td>
 </tr>
 </tbody>
 </table>
 <section id="ribasim.Edge.write_layer" class="level3" data-number="1.2.1">
 <h3 data-number="1.2.1" class="anchored" data-anchor-id="ribasim.Edge.write_layer"><span class="header-section-number">1.2.1</span> write_layer</h3>
 <p><code>Edge.write_layer(path)</code></p>
-<p>Write the contents of the input to a GeoPackage.</p>
+<p>Write the contents of the input to a database.</p>
 <section id="parameters-1" class="level4" data-number="1.2.1.1">
 <h4 data-number="1.2.1.1" class="anchored" data-anchor-id="parameters-1"><span class="header-section-number">1.2.1.1</span> Parameters</h4>
 <table class="table">

python/reference/Model.html

@@ -175,120 +175,114 @@ <h2 data-number="1.1" class="anchored" data-anchor-id="parameters"><span class="
 </thead>
 <tbody>
 <tr class="odd">
-<td><code>modelname</code></td>
-<td>str</td>
-<td>Model name, used in TOML and GeoPackage file name.</td>
-<td><em>required</em></td>
-</tr>
-<tr class="even">
 <td><code>node</code></td>
 <td>Node</td>
 <td>The ID, type and geometry of each node.</td>
 <td><em>required</em></td>
 </tr>
-<tr class="odd">
+<tr class="even">
 <td><code>edge</code></td>
 <td>Edge</td>
 <td>How the nodes are connected.</td>
 <td><em>required</em></td>
 </tr>
-<tr class="even">
+<tr class="odd">
 <td><code>basin</code></td>
 <td>Basin</td>
 <td>The waterbodies.</td>
 <td><em>required</em></td>
 </tr>
-<tr class="odd">
+<tr class="even">
 <td><code>fractional_flow</code></td>
 <td>Optional[FractionalFlow]</td>
 <td>Split flows into fractions.</td>
 <td><em>required</em></td>
 </tr>
-<tr class="even">
+<tr class="odd">
 <td><code>level_boundary</code></td>
 <td>Optional[LevelBoundary]</td>
 <td>Boundary condition specifying the water level.</td>
 <td><em>required</em></td>
 </tr>
-<tr class="odd">
+<tr class="even">
 <td><code>flow_boundary</code></td>
 <td>Optional[FlowBoundary]</td>
 <td>Boundary conditions specifying the flow.</td>
 <td><em>required</em></td>
 </tr>
-<tr class="even">
+<tr class="odd">
 <td><code>linear_resistance</code></td>
 <td></td>
 <td>Linear flow resistance.</td>
 <td><em>required</em></td>
 </tr>
-<tr class="odd">
+<tr class="even">
 <td><code>manning_resistance</code></td>
 <td>Optional[ManningResistance]</td>
 <td>Flow resistance based on the Manning formula.</td>
 <td><em>required</em></td>
 </tr>
-<tr class="even">
+<tr class="odd">
 <td><code>tabulated_rating_curve</code></td>
 <td>Optional[TabulatedRatingCurve]</td>
 <td>Tabulated rating curve describing flow based on the upstream water level.</td>
 <td><em>required</em></td>
 </tr>
-<tr class="odd">
+<tr class="even">
 <td><code>pump</code></td>
 <td>Optional[Pump]</td>
 <td>Prescribed flow rate from one basin to the other.</td>
 <td><em>required</em></td>
 </tr>
-<tr class="even">
+<tr class="odd">
 <td><code>outlet</code></td>
 <td>Optional[Outlet]</td>
 <td>Prescribed flow rate from one basin to the other.</td>
 <td><em>required</em></td>
 </tr>
-<tr class="odd">
+<tr class="even">
 <td><code>terminal</code></td>
 <td>Optional[Terminal]</td>
 <td>Water sink without state or properties.</td>
 <td><em>required</em></td>
 </tr>
-<tr class="even">
+<tr class="odd">
 <td><code>discrete_control</code></td>
 <td>Optional[DiscreteControl]</td>
 <td>Discrete control logic.</td>
 <td><em>required</em></td>
 </tr>
-<tr class="odd">
+<tr class="even">
 <td><code>pid_control</code></td>
 <td>Optional[PidControl]</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">
+<tr class="odd">
 <td><code>user</code></td>
 <td>Optional[User]</td>
 <td>User node type with demand and priority.</td>
 <td><em>required</em></td>
 </tr>
-<tr class="odd">
+<tr class="even">
 <td><code>starttime</code></td>
 <td>Union[str, datetime.datetime]</td>
 <td>Starting time of the simulation.</td>
 <td><em>required</em></td>
 </tr>
-<tr class="even">
+<tr class="odd">
 <td><code>endtime</code></td>
 <td>Union[str, datetime.datetime]</td>
 <td>End time of the simulation.</td>
 <td><em>required</em></td>
 </tr>
-<tr class="odd">
+<tr class="even">
 <td><code>solver</code></td>
 <td>Optional[Solver]</td>
 <td>Solver settings.</td>
 <td><em>required</em></td>
 </tr>
-<tr class="even">
+<tr class="odd">
 <td><code>logging</code></td>
 <td>Optional[logging]</td>
 <td>Logging settings.</td>
@@ -341,7 +335,7 @@ <h2 data-number="1.2" class="anchored" data-anchor-id="methods"><span class="hea
 </tr>
 <tr class="odd">
 <td><a href="#ribasim.Model.write">write</a></td>
-<td>Write the contents of the model to a GeoPackage and a TOML configuration file.</td>
+<td>Write the contents of the model to a database and a TOML configuration file.</td>
 </tr>
 </tbody>
 </table>
@@ -478,8 +472,8 @@ <h3 data-number="1.2.8" class="anchored" data-anchor-id="ribasim.Model.validate_
 <section id="ribasim.Model.write" class="level3" data-number="1.2.9">
 <h3 data-number="1.2.9" class="anchored" data-anchor-id="ribasim.Model.write"><span class="header-section-number">1.2.9</span> write</h3>
 <p><code>Model.write(directory)</code></p>
-<p>Write the contents of the model to a GeoPackage and a TOML configuration file.</p>
-<p>If <code>directory</code> does not exist, it is created before writing. The GeoPackage and TOML file will be called <code>{modelname}.gpkg</code> and <code>{modelname}.toml</code> respectively.</p>
+<p>Write the contents of the model to a database and a TOML configuration file.</p>
+<p>If <code>directory</code> does not exist, it is created before writing.</p>
 <section id="parameters-3" class="level4" data-number="1.2.9.1">
 <h4 data-number="1.2.9.1" class="anchored" data-anchor-id="parameters-3"><span class="header-section-number">1.2.9.1</span> Parameters</h4>
 <table class="table">

python/reference/Node.html

@@ -191,7 +191,7 @@ <h2 data-number="1.2" class="anchored" data-anchor-id="methods"><span class="hea
 </tr>
 <tr class="even">
 <td><a href="#ribasim.Node.write_layer">write_layer</a></td>
-<td>Write the contents of the input to a GeoPackage.</td>
+<td>Write the contents of the input to a database.</td>
 </tr>
 </tbody>
 </table>
@@ -247,7 +247,7 @@ <h4 data-number="1.2.1.2" class="anchored" data-anchor-id="returns"><span class=
 <section id="ribasim.Node.write_layer" class="level3" data-number="1.2.2">
 <h3 data-number="1.2.2" class="anchored" data-anchor-id="ribasim.Node.write_layer"><span class="header-section-number">1.2.2</span> write_layer</h3>
 <p><code>Node.write_layer(path)</code></p>
-<p>Write the contents of the input to a GeoPackage.</p>
+<p>Write the contents of the input to a database.</p>
 <section id="parameters-2" class="level4" data-number="1.2.2.1">
 <h4 data-number="1.2.2.1" class="anchored" data-anchor-id="parameters-2"><span class="header-section-number">1.2.2.1</span> Parameters</h4>
 <table class="table">

python/reference/index.html

@@ -194,7 +194,7 @@ <h2 data-number="1.1" class="anchored" data-anchor-id="model"><span class="heade
 </section>
 <section id="network" class="level2" data-number="1.2">
 <h2 data-number="1.2" class="anchored" data-anchor-id="network"><span class="header-section-number">1.2</span> Network</h2>
-<p>The Node and Edge GeoPackage layers define the network layout.</p>
+<p>The Node and Edge database layers define the network layout.</p>
 <table class="table">
 <tbody>
 <tr class="odd">

qgis/index.html

@@ -182,7 +182,7 @@ <h2 id="toc-title">On this page</h2>
   <li><a href="#run-a-model" id="toc-run-a-model" class="nav-link" data-scroll-target="#run-a-model"><span class="header-section-number">1.4</span> Run a model</a></li>
   <li><a href="#sec-results" id="toc-sec-results" class="nav-link" data-scroll-target="#sec-results"><span class="header-section-number">1.5</span> Inspect results</a>
   <ul class="collapse">
-  <li><a href="#associate-output-to-imod-time-series-window" id="toc-associate-output-to-imod-time-series-window" class="nav-link" data-scroll-target="#associate-output-to-imod-time-series-window"><span class="header-section-number">1.5.1</span> Associate output to iMOD time series window</a></li>
+  <li><a href="#associate-results-to-imod-time-series-window" id="toc-associate-results-to-imod-time-series-window" class="nav-link" data-scroll-target="#associate-results-to-imod-time-series-window"><span class="header-section-number">1.5.1</span> Associate results to iMOD time series window</a></li>
   <li><a href="#plot-time-series" id="toc-plot-time-series" class="nav-link" data-scroll-target="#plot-time-series"><span class="header-section-number">1.5.2</span> Plot time series</a></li>
   </ul></li>
   </ul></li>
@@ -248,7 +248,7 @@ <h3 data-number="1.1.2" class="anchored" data-anchor-id="add-imod-plugin"><span
 </section>
 <section id="prepare-your-model" class="level3" data-number="1.1.3">
 <h3 data-number="1.1.3" class="anchored" data-anchor-id="prepare-your-model"><span class="header-section-number">1.1.3</span> Prepare your model</h3>
-<p>Open example model <code>basic.gpkg</code> or create a new model.</p>
+<p>Open example model <code>database.gpkg</code> or create a new model.</p>
 <div class="quarto-figure quarto-figure-left">
 <figure class="figure">
 <p><img src="https://user-images.githubusercontent.com/4471859/224939126-b38f0eed-2e89-4120-b541-5b8c31798c09.png" class="img-fluid figure-img"></p>
@@ -260,7 +260,7 @@ <h3 data-number="1.1.3" class="anchored" data-anchor-id="prepare-your-model"><sp
 <p><img src="https://user-images.githubusercontent.com/4471859/224939143-19e9931e-da4b-4717-ba28-67a0f141dd40.png" class="img-fluid figure-img"></p>
 </figure>
 </div>
-<p>If you are working with an unknown CRS, right click the model GeoPackage group in Layers, and click “Set Group CRS…”.</p>
+<p>If you are working with an unknown CRS, right click the model database group in Layers, and click “Set Group CRS…”.</p>
 <div class="quarto-figure quarto-figure-left">
 <figure class="figure">
 <p><img src="https://user-images.githubusercontent.com/4471859/224939165-45807f16-2d3a-41b3-92a2-7fe0e86ae72b.png" class="img-fluid figure-img"></p>
@@ -362,40 +362,40 @@ <h3 data-number="1.3.2" class="anchored" data-anchor-id="create-connecting-edges
 <section id="run-a-model" class="level2" data-number="1.4">
 <h2 data-number="1.4" class="anchored" data-anchor-id="run-a-model"><span class="header-section-number">1.4</span> Run a model</h2>
 <ul>
-<li>Open a text editor and create an empty file next to your GeoPackage, with the <code>.toml</code> extension.</li>
+<li>Open a text editor and create an empty file next to your database, with the <code>.toml</code> extension.</li>
 <li>Add the following content to the TOML file:</li>
 </ul>
 <div class="code-with-filename">
 <div class="code-with-filename-file">
-<pre><strong>basic.toml</strong></pre>
+<pre><strong>ribasim.toml</strong></pre>
 </div>
 <div class="sourceCode" id="cb1"><pre class="sourceCode TOML code-with-copy"><code class="sourceCode toml"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="dt">starttime</span> <span class="op">=</span> <span class="bn">2020-01-01 00:00:00</span></span>
 <span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a><span class="dt">endtime</span> <span class="op">=</span> <span class="bn">2021-01-01 00:00:00</span></span>
-<span id="cb1-3"><a href="#cb1-3" aria-hidden="true" tabindex="-1"></a><span class="dt">geopackage</span> <span class="op">=</span> <span class="st">"basic.gpkg"</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
+<span id="cb1-3"><a href="#cb1-3" aria-hidden="true" tabindex="-1"></a><span class="dt">database</span> <span class="op">=</span> <span class="st">"database.gpkg"</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
 </div>
 <ul>
 <li>Unzip the Ribasim command line interface, <code>ribasim_cli.zip</code></li>
-<li>Open your terminal and go to the directory where your TOML is stored. Now run <code>path/to/ribasim_cli/ribasim basic.toml</code>. Adjust the path to the <code>ribasim_cli</code> folder to where you placed it. This runs the model.</li>
-<li>In your model directory there is now an <code>output/</code> folder with <code>basin.arrow</code> and <code>flow.arrow</code> output files.</li>
+<li>Open your terminal and go to the directory where your TOML is stored. Now run <code>path/to/ribasim_cli/ribasim ribasim.toml</code>. Adjust the path to the <code>ribasim_cli</code> folder to where you placed it. This runs the model.</li>
+<li>In your model directory there is now a <code>results/</code> folder with <code>basin.arrow</code> and <code>flow.arrow</code> output files.</li>
 </ul>
 </section>
 <section id="sec-results" class="level2" data-number="1.5">
 <h2 data-number="1.5" class="anchored" data-anchor-id="sec-results"><span class="header-section-number">1.5</span> Inspect results</h2>
-<section id="associate-output-to-imod-time-series-window" class="level3" data-number="1.5.1">
-<h3 data-number="1.5.1" class="anchored" data-anchor-id="associate-output-to-imod-time-series-window"><span class="header-section-number">1.5.1</span> Associate output to iMOD time series window</h3>
+<section id="associate-results-to-imod-time-series-window" class="level3" data-number="1.5.1">
+<h3 data-number="1.5.1" class="anchored" data-anchor-id="associate-results-to-imod-time-series-window"><span class="header-section-number">1.5.1</span> Associate results to iMOD time series window</h3>
 <p>In QGIS select the model group.</p>
 <div class="quarto-figure quarto-figure-left">
 <figure class="figure">
 <p><img src="https://user-images.githubusercontent.com/4471859/224939378-a026aec7-419d-4e6e-8b20-df80aa415659.png" class="img-fluid figure-img"></p>
 </figure>
 </div>
-<p>In the Ribasim plugin widget, select the Output tab and click “Associate Output”.</p>
+<p>In the Ribasim plugin widget, select the Results tab and click “Associate Results”.</p>
 <div class="quarto-figure quarto-figure-left">
 <figure class="figure">
 <p><img src="https://user-images.githubusercontent.com/4471859/224939389-17add58d-6701-49c5-a23a-ce367572d9cd.png" class="img-fluid figure-img"></p>
 </figure>
 </div>
-<p>Select <code>output/basin.arrow</code>.</p>
+<p>Select <code>results/basin.arrow</code>.</p>
 <div class="quarto-figure quarto-figure-left">
 <figure class="figure">
 <p><img src="https://user-images.githubusercontent.com/4471859/224939408-5c291840-90a4-4efa-a2f0-4fb5986b8779.png" class="img-fluid figure-img"></p>

schema/Config.schema.json

@@ -28,21 +28,21 @@
             "type": "string",
             "default": "."
         },
-        "output_dir": {
+        "results_dir": {
             "format": "default",
             "type": "string",
             "default": "."
         },
-        "geopackage": {
+        "database": {
             "format": "default",
             "type": "string"
         },
-        "output": {
-            "$ref": "https://deltares.github.io/Ribasim/schema/Output.schema.json",
+        "results": {
+            "$ref": "https://deltares.github.io/Ribasim/schema/Results.schema.json",
             "default": {
-                "basin": "output/basin.arrow",
-                "flow": "output/flow.arrow",
-                "control": "output/control.arrow",
+                "basin": "results/basin.arrow",
+                "flow": "results/flow.arrow",
+                "control": "results/control.arrow",
                 "outstate": null,
                 "compression": "zstd",
                 "compression_level": 6
@@ -169,9 +169,9 @@
         "update_timestep",
         "relative_dir",
         "input_dir",
-        "output_dir",
-        "geopackage",
-        "output",
+        "results_dir",
+        "database",
+        "results",
         "solver",
         "logging",
         "terminal",

schema/Output.schema.json → schema/Results.schema.json

@@ -1,24 +1,24 @@
 {
     "$schema": "https://json-schema.org/draft/2020-12/schema",
-    "$id": "https://deltares.github.io/Ribasim/schema/Output.schema.json",
-    "title": "Output",
-    "description": "A Output object based on Ribasim.config.Output",
+    "$id": "https://deltares.github.io/Ribasim/schema/Results.schema.json",
+    "title": "Results",
+    "description": "A Results object based on Ribasim.config.Results",
     "type": "object",
     "properties": {
         "basin": {
             "format": "default",
             "type": "string",
-            "default": "output/basin.arrow"
+            "default": "results/basin.arrow"
         },
         "flow": {
             "format": "default",
             "type": "string",
-            "default": "output/flow.arrow"
+            "default": "results/flow.arrow"
         },
         "control": {
             "format": "default",
             "type": "string",
-            "default": "output/control.arrow"
+            "default": "results/control.arrow"
         },
         "outstate": {
             "format": "default",