Skip to content

Commit fac9bde

Browse files
author
Sam Hatchett
committed
cleaning up the repo, hopefully making things more organized
1 parent 9e59f24 commit fac9bde

19 files changed

+7
-15
lines changed

.coveralls.yml.enc

-1
This file was deleted.

README.md

+7-14
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,18 @@
11
# epanet-python
2-
Is home for Python packages related to the EPANET engine.
3-
4-
5-
## Build Status
6-
[![Build status](https://ci.appveyor.com/api/projects/status/lrm84lry4p9obwl6/branch/dev?svg=true)](https://ci.appveyor.com/project/michaeltryby/epanet-python/branch/dev)
7-
8-
[![Coverage Status](https://coveralls.io/repos/github/michaeltryby/epanet-python/badge.svg?branch=dev)](https://coveralls.io/github/michaeltryby/epanet-python?branch=dev)
2+
The home for Python packages related to the EPANET engine.
93

104

115
## Contents
12-
* owa-epanet - the thinnest of SWIG-generated wrappers for EPANET.
6+
* owa-epanet - the thinnest of SWIG-generated wrappers for EPANET. Updated frequently alongside OWA:EPANET.
137
* epanet-module - A ctypes based wrapper for the EPANET Toolkit (with support for reading EPANET binary output files).
14-
* epanet-python - SWIG based wrappers for the EPANET Toolkit and Output libraries.
15-
* ...
8+
* epanet-python - SWIG based wrappers for the EPANET Toolkit and Output libraries. Deprecated.
169

1710

1811
## Motivation
19-
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. SWIG-wrapping will mean that the epanet library becomes scriptable from within a GUI.
20-
21-
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.
12+
These Python wrappers for EPANET are available to developers interested in building higher level functionality on top.
2213

14+
## Which wrapper to use
15+
This depends on user preference. Using a ctypes may have certain advantages. Alternatively, starting with an auto-generated python API wrapper is a good foundation for building more abstractions, and SWIG-wrapping means that the Python package gets automatically updated whenever new core features are available.
2316

2417
## Contributing
25-
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!
18+
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! Just open an issue or chat with others on the [community forum](http://community.wateranalytics.org).
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

setup.cfg epanet_python/setup.cfg

File renamed without changes.

setup.py epanet_python/setup.py

File renamed without changes.

tox.ini epanet_python/tox.ini

File renamed without changes.

0 commit comments

Comments
 (0)