Merge dev into main

WaterFutures · Dec 28, 2024 · 9529d63 · 9529d63
2 parents 8e11443 + d599944
commit 9529d63
Show file tree

Hide file tree

Showing 63 changed files with 1,392 additions and 603 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -10,4 +10,7 @@ sphinx:
 
 python:
   install:
-  - requirements: docs/requirements.txt
+  - requirements: docs/requirements.txt
+
+formats:
+  - pdf
diff --git a/docs/conf.py b/docs/conf.py
@@ -20,7 +20,7 @@
 
 project = 'EPyT-Flow'
 copyright = 'EPyT-Flow Developers, 2024'
-author = 'André Artelt, Marios S. Kyriakou, Stelios G. Vrachimis'
+author = 'André Artelt, Marios S. Kyriakou, Stelios G. Vrachimis, et al.'
 
 
 # -- General configuration ---------------------------------------------------

diff --git a/docs/examples/abrupt_leakage.ipynb b/docs/examples/abrupt_leakage.ipynb
@@ -177,17 +177,27 @@
    "source": [
     "sim.close()"
    ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
   }
  ],
  "metadata": {
-  "kernelspec": {
-   "display_name": "epytflow2",
-   "language": "python",
-   "name": "python3"
-  },
   "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
    "name": "python",
-   "version": "3.9.18"
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.9.20"
   }
  },
  "nbformat": 4,

diff --git a/docs/examples/basic_usage.ipynb b/docs/examples/basic_usage.ipynb
@@ -203,17 +203,27 @@
    "source": [
     "sim.close()"
    ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
   }
  ],
  "metadata": {
-  "kernelspec": {
-   "display_name": "epytflow2",
-   "language": "python",
-   "name": "python3"
-  },
   "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
    "name": "python",
-   "version": "3.9.18"
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.9.20"
   }
  },
  "nbformat": 4,

diff --git a/docs/examples/chlorine_injection.ipynb b/docs/examples/chlorine_injection.ipynb
@@ -194,14 +194,17 @@
   }
  ],
  "metadata": {
-  "kernelspec": {
-   "display_name": "epytflow2",
-   "language": "python",
-   "name": "python3"
-  },
   "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
    "name": "python",
-   "version": "3.9.18"
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.9.20"
   }
  },
  "nbformat": 4,

diff --git a/docs/examples/control_example.ipynb b/docs/examples/control_example.ipynb
@@ -219,14 +219,17 @@
   }
  ],
  "metadata": {
-  "kernelspec": {
-   "display_name": "epytflow2",
-   "language": "python",
-   "name": "python3"
-  },
   "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
    "name": "python",
-   "version": "3.9.18"
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.9.20"
   }
  },
  "nbformat": 4,

diff --git a/docs/examples/event_detection.ipynb b/docs/examples/event_detection.ipynb
@@ -265,7 +265,16 @@
  ],
  "metadata": {
   "language_info": {
-   "name": "python"
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.9.20"
   }
  },
  "nbformat": 4,

diff --git a/docs/examples/net2-cl2_example.ipynb b/docs/examples/net2-cl2_example.ipynb
@@ -141,14 +141,17 @@
   }
  ],
  "metadata": {
-  "kernelspec": {
-   "display_name": "epytflow2",
-   "language": "python",
-   "name": "python3"
-  },
   "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
    "name": "python",
-   "version": "3.9.18"
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.9.20"
   }
  },
  "nbformat": 4,

diff --git a/docs/examples/network_topology.ipynb b/docs/examples/network_topology.ipynb
@@ -290,7 +290,16 @@
  ],
  "metadata": {
   "language_info": {
-   "name": "python"
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.9.20"
   }
  },
  "nbformat": 4,

diff --git a/docs/examples/plot_network.ipynb b/docs/examples/plot_network.ipynb
@@ -110,7 +110,16 @@
  ],
  "metadata": {
   "language_info": {
-   "name": "python"
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.9.20"
   }
  },
  "nbformat": 4,

diff --git a/docs/examples/pump_states.ipynb b/docs/examples/pump_states.ipynb
@@ -184,7 +184,16 @@
  ],
  "metadata": {
   "language_info": {
-   "name": "python"
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.9.20"
   }
  },
  "nbformat": 4,

diff --git a/docs/examples/sensor_fault.ipynb b/docs/examples/sensor_fault.ipynb
@@ -167,7 +167,16 @@
  ],
  "metadata": {
   "language_info": {
-   "name": "python"
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.9.20"
   }
  },
  "nbformat": 4,

diff --git a/docs/examples/sensor_override_attack.ipynb b/docs/examples/sensor_override_attack.ipynb
@@ -176,7 +176,16 @@
  ],
  "metadata": {
   "language_info": {
-   "name": "python"
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.9.20"
   }
  },
  "nbformat": 4,

diff --git a/docs/examples/sensor_replay_attack.ipynb b/docs/examples/sensor_replay_attack.ipynb
@@ -219,7 +219,16 @@
  ],
  "metadata": {
   "language_info": {
-   "name": "python"
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.9.20"
   }
  },
  "nbformat": 4,

diff --git a/docs/examples/uncertainties.ipynb b/docs/examples/uncertainties.ipynb
@@ -113,7 +113,7 @@
    "source": [
     "uc = RelativeUniformUncertainty(low=0.75, high=1.25)\n",
     "\n",
-    "sim.set_model_uncertainty(ModelUncertainty(demand_pattern_uncertainty=uc))"
+    "sim.set_model_uncertainty(ModelUncertainty(global_demand_pattern_uncertainty=uc))"
    ]
   },
   {
@@ -164,8 +164,16 @@
    "name": "python3"
   },
   "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
    "name": "python",
-   "version": "3.9.18"
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.9.20"
   }
  },
  "nbformat": 4,

diff --git a/docs/examples/visualization.ipynb b/docs/examples/visualization.ipynb
@@ -258,14 +258,17 @@
    "source": [
     "wdn.close()"
    ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "df3db290",
+   "metadata": {},
+   "outputs": [],
+   "source": []
   }
  ],
  "metadata": {
-  "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
-   "language": "python",
-   "name": "python3"
-  },
   "language_info": {
    "codemirror_mode": {
     "name": "ipython",
@@ -276,7 +279,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.12.4"
+   "version": "3.9.20"
   }
  },
  "nbformat": 4,

diff --git a/docs/examples/water_age.ipynb b/docs/examples/water_age.ipynb
@@ -159,14 +159,17 @@
   }
  ],
  "metadata": {
-  "kernelspec": {
-   "display_name": "epytflow2",
-   "language": "python",
-   "name": "python3"
-  },
   "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
    "name": "python",
-   "version": "3.9.18"
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.9.20"
   }
  },
  "nbformat": 4,

diff --git a/docs/tut.quality.rst b/docs/tut.quality.rst
@@ -192,10 +192,10 @@ Example of a scenario where we want to monitor chlorine in Net2:
         sim.set_general_parameters(simulation_duration=to_seconds(days=5))
 
         # Monitor bulk species "CL2" at every node
-        sim.set_bulk_species_sensors(sensor_info={"CL2": sim.sensor_config.nodes})
+        sim.set_bulk_species_node_sensors(sensor_info={"CL2": sim.sensor_config.nodes})
 
         # Run entire simulation
         res = sim.run_simulation(verbose=True)
 
         # Show concentration of chlorine species at every node
-        print(res.get_data_bulk_species_concentration())
+        print(res.get_data_bulk_species_node_concentration())
diff --git a/docs/tut.scenarios.rst b/docs/tut.scenarios.rst
@@ -428,6 +428,15 @@ several (WDN related) benchmark data sets from the literature:
 +--------------------------------+---------------------------------------------------------------------------------------------+
 
 
+
+WaterBenchmarkHub
++++++++++++++++++
+
+For more networks and benchmarks, check-out the
+`WaterBenchmarkHub <https://waterfutures.github.io/WaterBenchmarkHub>`_,
+a platform for accessing and sharing Water Distribution Network (WDN) benchmarks and data sets.
+
+
 .. [1] Vrachimis et al. (2018) -- see https://github.com/KIOS-Research/LeakDB/
 .. [2] Vrachmimis et al. (2020) -- see https://github.com/KIOS-Research/BattLeDIM
 .. [3] Taormina et al. (2017) -- see https://www.batadal.net/