Built site for gh-pages

Deltares · Sep 15, 2023 · d1e98cb · d1e98cb
1 parent 7e85735
commit d1e98cb
Show file tree

Hide file tree

Showing 21 changed files with 504 additions and 222 deletions.
diff --git a/.nojekyll b/.nojekyll
@@ -1 +1 @@
-e0ec266e
+b39dc898
diff --git a/build/index.html b/build/index.html
diff --git a/contribute/addnode.html b/contribute/addnode.html
diff --git a/core/usage.html b/core/usage.html
diff --git a/python/examples.html b/python/examples.html
@@ -548,7 +548,7 @@ <h1 data-number="2"><span class="header-section-number">2</span> Update the basi
 <span id="cb26-4"><a href="#cb26-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="cb26-5"><a href="#cb26-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 0x7fe11670bf10&gt;</code></pre>
+<pre><code>&lt;matplotlib.legend.Legend at 0x7fc2f5d90250&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>

diff --git a/python/reference/Model.html b/python/reference/Model.html
@@ -265,24 +265,30 @@ <h2 data-number="1.1" class="anchored" data-anchor-id="parameters"><span class="
 <td><em>required</em></td>
 </tr>
 <tr class="even">
+<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">
 <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="odd">
+<tr class="even">
 <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="even">
+<tr class="odd">
 <td><code>solver</code></td>
 <td>Optional[Solver]</td>
 <td>Solver settings.</td>
 <td><em>required</em></td>
 </tr>
-<tr class="odd">
+<tr class="even">
 <td><code>logging</code></td>
 <td>Optional[logging]</td>
 <td>Logging settings.</td>

diff --git a/schema/Config.schema.json b/schema/Config.schema.json
@@ -38,6 +38,13 @@
             },
             "$ref": "https://deltares.github.io/Ribasim/schema/level_boundary.schema.json"
         },
+        "user": {
+            "default": {
+                "static": null,
+                "time": null
+            },
+            "$ref": "https://deltares.github.io/Ribasim/schema/user.schema.json"
+        },
         "pump": {
             "default": {
                 "static": null
@@ -165,6 +172,7 @@
         "level_boundary",
         "pump",
         "tabulated_rating_curve",
+        "user",
         "flow_boundary",
         "basin",
         "manning_resistance",

diff --git a/schema/DiscreteControlCondition.schema.json b/schema/DiscreteControlCondition.schema.json
@@ -27,10 +27,10 @@
             "format": "default",
             "anyOf": [
                 {
-                    "type": "null"
+                    "type": "number"
                 },
                 {
-                    "type": "number"
+                    "type": "null"
                 }
             ]
         }

diff --git a/schema/FlowBoundaryStatic.schema.json b/schema/FlowBoundaryStatic.schema.json
@@ -11,10 +11,10 @@
             "format": "default",
             "anyOf": [
                 {
-                    "type": "null"
+                    "type": "boolean"
                 },
                 {
-                    "type": "boolean"
+                    "type": "null"
                 }
             ]
         },

diff --git a/schema/LevelBoundaryStatic.schema.json b/schema/LevelBoundaryStatic.schema.json
@@ -11,10 +11,10 @@
             "format": "default",
             "anyOf": [
                 {
-                    "type": "null"
+                    "type": "boolean"
                 },
                 {
-                    "type": "boolean"
+                    "type": "null"
                 }
             ]
         },

diff --git a/schema/LinearResistanceStatic.schema.json b/schema/LinearResistanceStatic.schema.json
@@ -11,10 +11,10 @@
             "format": "default",
             "anyOf": [
                 {
-                    "type": "null"
+                    "type": "boolean"
                 },
                 {
-                    "type": "boolean"
+                    "type": "null"
                 }
             ]
         },

diff --git a/schema/ManningResistanceStatic.schema.json b/schema/ManningResistanceStatic.schema.json
@@ -19,10 +19,10 @@
             "format": "default",
             "anyOf": [
                 {
-                    "type": "null"
+                    "type": "boolean"
                 },
                 {
-                    "type": "boolean"
+                    "type": "null"
                 }
             ]
         },

diff --git a/schema/OutletStatic.schema.json b/schema/OutletStatic.schema.json
@@ -5,10 +5,10 @@
             "format": "default",
             "anyOf": [
                 {
-                    "type": "null"
+                    "type": "number"
                 },
                 {
-                    "type": "number"
+                    "type": "null"
                 }
             ]
         },
@@ -22,21 +22,21 @@
             "format": "default",
             "anyOf": [
                 {
-                    "type": "null"
+                    "type": "boolean"
                 },
                 {
-                    "type": "boolean"
+                    "type": "null"
                 }
             ]
         },
         "min_crest_level": {
             "format": "default",
             "anyOf": [
                 {
-                    "type": "null"
+                    "type": "number"
                 },
                 {
-                    "type": "number"
+                    "type": "null"
                 }
             ]
         },
@@ -63,10 +63,10 @@
             "format": "default",
             "anyOf": [
                 {
-                    "type": "null"
+                    "type": "number"
                 },
                 {
-                    "type": "number"
+                    "type": "null"
                 }
             ]
         }

diff --git a/schema/PIDControlStatic.schema.json b/schema/PIDControlStatic.schema.json
@@ -19,10 +19,10 @@
             "format": "default",
             "anyOf": [
                 {
-                    "type": "null"
+                    "type": "boolean"
                 },
                 {
-                    "type": "boolean"
+                    "type": "null"
                 }
             ]
         },

diff --git a/schema/PumpStatic.schema.json b/schema/PumpStatic.schema.json
@@ -5,10 +5,10 @@
             "format": "default",
             "anyOf": [
                 {
-                    "type": "null"
+                    "type": "number"
                 },
                 {
-                    "type": "number"
+                    "type": "null"
                 }
             ]
         },
@@ -22,10 +22,10 @@
             "format": "default",
             "anyOf": [
                 {
-                    "type": "null"
+                    "type": "boolean"
                 },
                 {
-                    "type": "boolean"
+                    "type": "null"
                 }
             ]
         },
@@ -52,10 +52,10 @@
             "format": "default",
             "anyOf": [
                 {
-                    "type": "null"
+                    "type": "number"
                 },
                 {
-                    "type": "number"
+                    "type": "null"
                 }
             ]
         }

diff --git a/schema/TabulatedRatingCurveStatic.schema.json b/schema/TabulatedRatingCurveStatic.schema.json
@@ -11,10 +11,10 @@
             "format": "default",
             "anyOf": [
                 {
-                    "type": "null"
+                    "type": "boolean"
                 },
                 {
-                    "type": "boolean"
+                    "type": "null"
                 }
             ]
         },

diff --git a/schema/UserStatic.schema.json b/schema/UserStatic.schema.json
@@ -0,0 +1,53 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "properties": {
+        "remarks": {
+            "format": "default",
+            "default": "",
+            "description": "a hack for pandera",
+            "type": "string"
+        },
+        "priority": {
+            "format": "default",
+            "type": "integer"
+        },
+        "active": {
+            "format": "default",
+            "anyOf": [
+                {
+                    "type": "boolean"
+                },
+                {
+                    "type": "null"
+                }
+            ]
+        },
+        "demand": {
+            "format": "double",
+            "type": "number"
+        },
+        "return_factor": {
+            "format": "double",
+            "type": "number"
+        },
+        "min_level": {
+            "format": "double",
+            "type": "number"
+        },
+        "node_id": {
+            "format": "default",
+            "type": "integer"
+        }
+    },
+    "required": [
+        "node_id",
+        "demand",
+        "return_factor",
+        "min_level",
+        "priority"
+    ],
+    "$id": "https://deltares.github.io/Ribasim/schema/UserStatic.schema.json",
+    "title": "UserStatic",
+    "description": "A UserStatic object based on Ribasim.UserStaticV1",
+    "type": "object"
+}
diff --git a/schema/UserTime.schema.json b/schema/UserTime.schema.json
@@ -0,0 +1,47 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "properties": {
+        "remarks": {
+            "format": "default",
+            "default": "",
+            "description": "a hack for pandera",
+            "type": "string"
+        },
+        "priority": {
+            "format": "default",
+            "type": "integer"
+        },
+        "time": {
+            "format": "date-time",
+            "type": "string"
+        },
+        "demand": {
+            "format": "double",
+            "type": "number"
+        },
+        "return_factor": {
+            "format": "double",
+            "type": "number"
+        },
+        "min_level": {
+            "format": "double",
+            "type": "number"
+        },
+        "node_id": {
+            "format": "default",
+            "type": "integer"
+        }
+    },
+    "required": [
+        "node_id",
+        "time",
+        "demand",
+        "return_factor",
+        "min_level",
+        "priority"
+    ],
+    "$id": "https://deltares.github.io/Ribasim/schema/UserTime.schema.json",
+    "title": "UserTime",
+    "description": "A UserTime object based on Ribasim.UserTimeV1",
+    "type": "object"
+}
diff --git a/schema/root.schema.json b/schema/root.schema.json
@@ -10,12 +10,18 @@
         "FlowBoundaryTime": {
             "$ref": "FlowBoundaryTime.schema.json"
         },
+        "UserStatic": {
+            "$ref": "UserStatic.schema.json"
+        },
         "PumpStatic": {
             "$ref": "PumpStatic.schema.json"
         },
         "LevelBoundaryStatic": {
             "$ref": "LevelBoundaryStatic.schema.json"
         },
+        "UserTime": {
+            "$ref": "UserTime.schema.json"
+        },
         "DiscreteControlCondition": {
             "$ref": "DiscreteControlCondition.schema.json"
         },