From 3cd95574b0a6afc5165e1fa929991e54bb678023 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Artelt?= Date: Sun, 26 May 2024 21:25:40 +0200 Subject: [PATCH] Update README: List unique features --- README.md | 17 +++++++++++++++++ docs/index.rst | 16 ++++++++++++++++ 2 files changed, 33 insertions(+) diff --git a/README.md b/README.md index 824fd71..9cf7607 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,23 @@ Furthermore, it also provides an environment for developing and testing control ![](https://github.com/WaterFutures/EPyT-Flow/blob/main/docs/_static/net1_plot.png?raw=true) + +## Unique Features + +Unique features of EPyT-Flow that make it superior to other (Python) toolboxes are the following: + +- High-performance hydraulic and (advanced) water quality simulation +- High- and low-level interface +- Object-orientated design that is easy to extend and customize +- Sensor configurations +- Wide variety of pre-defined events (e.g. leakages, sensor faults, actuator events, cyber-attacks, etc.) +- Wide variety of pre-defined types of uncertainties (e.g. model uncertainties) +- Step-wise simulation and environment for training and evaluating control strategies +- Serialization module for easy exchange of data and (scenario) configurations +- REST API to make EPyT-Flow accessible in other applications +- Access to many WDNs and popular benchmarks (incl. their evaluation) + + ## Installation EPyT-Flow supports Python 3.9 - 3.12 diff --git a/docs/index.rst b/docs/index.rst index d697255..9563756 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,6 +13,22 @@ and `EPANET-MSX `_. EPyT-Flow provides easy access to popular benchmark data sets for event detection and localization. Furthermore, it also provides an environment for developing and testing control algorithms. +Unique Features +--------------- + +Unique features of EPyT-Flow that make it superior to other (Python) toolboxes are the following: + +- High-performance hydraulic and (advanced) water quality simulation +- High- and low-level interface +- Object-orientated design that is easy to extend and customize +- Sensor configurations +- Wide variety of pre-defined events (e.g. leakages, sensor faults, actuator events, cyber-attacks, etc.) +- Wide variety of pre-defined types of uncertainties (e.g. model uncertainties) +- Step-wise simulation and environment for training and evaluating control strategies +- Serialization module for easy exchange of data and (scenario) configurations +- REST API to make EPyT-Flow accessible in other applications +- Access to many WDNs and popular benchmarks (incl. their evaluation) + .. toctree:: :maxdepth: 2 :caption: User Guide