Welcome to EPANET-PLUS's documentation!
=======================================

EPANET-PLUS
+++++++++++

EPANET-PLUS is a C library that merges `EPANET <https://github.com/OpenWaterAnalytics/EPANET>`_ 
and `EPANET-MSX <https://github.com/USEPA/EPANETMSX/>`_ into a single library.
Most importantly, it also provides a Python package with a high-performance interface
(i.e., C extension) to the C library, together with additional helper functions for an easier
use of EPANET and EPANET-MSX.


Unique Features
---------------

Unique features of EPANET-PLUS that make it superior to other Python interfaces of EPANET are the following:

- High-performance (single) interface to the latest version of EPANET and EPANET-MSX
- Additional C-functions to extend EPANET and EPANET-MSX
- Python toolkit with handy functions for working with EPANET and EPANET-MSX 



.. toctree::
    :maxdepth: 2
    :caption: User Guide

    installation
    basicusage
    tut.overview

.. _tut.examples:

Examples
========
.. toctree::
   :maxdepth: 2
   :caption: Jupyter notebooks

   examples/basic_usage


API Reference
=============
.. toctree::
    :maxdepth: 2
    :caption: API Reference

    epanet_plus


Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`