oopnet 0.5.0

Object-oriented EPANET in Python

OOPNET

OOPNET (object-oriented EPANET) is a Python package for modelling and simulating hydraulic water distribution system models based on the modelling software EPANET.

Main functionalities:

• Reading EPANET input files (.inp)
• Modifying model components, settings, controls and rules
• Simulating models using EPANET with results as pandas data objects
• Plotting models using matplotlib

A detailed documentation is available under https://oopnet.readthedocs.io.

---

Warning!

Be warned, that OOPNET is still changing a lot. Until it's marked as 1.0.0, you should assume that it is unstable and act accordingly. We are trying to avoid breaking changes but they can and will occur!

---

Installation

OOPNET uses features only available in the newer Python version, which is why Python >= 3.9 is needed along with several Python package dependencies.

OOPNET is available on PyPI and can be easily installed together with its dependencies using pip:

pip install oopnet

Alternatively, you can install OOPNET from its repository:

pip install git+https://github.com/oopnet/oopnet.git

Dependencies

OOPNET requires the following Python packages:

• networkx
• numpy
• pandas
• xarray
• matplotlib
• bokeh

On Linux and macOS, EPANET has to be installed as well and has to be added to the path environment variable. Windows users don't have to have EPANET installed.

Basic Usage

To use OOPNET, you first have to import it in your script:

import oopnet as on

In OOPNET, everything is about the Network. If you want to start with a new, empty Network, type the following:

network = on.Network()

If you want to read an existing EPANET model, you can read it as an input-file:

filename = "network.inp"
network = on.Network.read(filename)

To simulate the model, you can use the Network`s run method:

report = network.run()

If you want to create a basic Network plot, you can use its plot method:

network.plot()

License

OOPNET is available under a MIT License.

Contributing

If you want to contribute, please check out our Code of Conduct and our Contribution Guide. Looking forward to your pull request or issue!

Citing

If you publish work based on OOPNET, we appreciate a citation of the following reference:

• Steffelbauer, D., Fuchs-Hanusch, D., 2015. OOPNET: an object-oriented EPANET in Python. Procedia Eng. 119, 710e718. https://doi.org/10.1016/j.proeng.2015.08.924.