Skip to content

Commit 03ed564

Browse files
committed
Adding README.md with project information
1 parent bc4da20 commit 03ed564

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# epanet-python
2+
Is home for Python packages related to the EPANET engine.
3+
4+
## Contents
5+
*epanet-module - A ctypes based wrapper for the EPANET Toolkit (with support for reading EPANET binary output files).
6+
*epanet-output - A SWIG based wrapper for the EPANET C Output library.
7+
*epanet-toolkit - A SWIG based wrapper for the EPANET Toolkit.
8+
*nrtest-epanet - A plugin for performing numerical regression tests on EPANET (requires epanet-output).
9+
* ...
10+
11+
## Motivation
12+
These Python wrappers for EPANET are available to developers interested in building higher level functionality on top. Starting with a clean, auto-generated python API wrapper is a good foundation for building more abstractions. This also intersects with the near-term needs of the GUI work (which uses python and QT) - SWIG-wrapping will mean that the epanet library becomes scriptable from within the GUI.
13+
14+
Another benefit of auto-generating the wrapper is that it's fairly unambiguous; nobody's personal preferences get involved until we get to slightly higher-level abstractions, but everyone can share and benefit from the foundational SWIG layer.
15+
16+
## Contributing
17+
There are many ways for those interested in contributing to participate - providing software development support, helping with documentation, finding bugs, or contributing feature requests. Feel free to get involved!

0 commit comments

Comments
 (0)