Merge pull request #7 from michaeltryby/master

Moving files into subfolder

Author: michaeltryby

README.md

@@ -1,15 +1,17 @@
 # epanet-python
-python wrapper for epanet library
-Works with both Python 2.7 and 3.x
+Is home for Python packages related to the EPANET engine. 
 
-## epamodule
-A Python module that permits Epanet toolkit library calls from pure Python programs.
-Dropped interface generated by ctypesgen from epanet2.h  (beacause not working with 2.x and 3.x)
+## Contents
+*epanet-module - A ctypes based wrapper for the EPANET Toolkit (with support for reading EPANET binary output files).
+*epanet-output - A SWIG based wrapper for the EPANET C Output library. 
+*epanet-toolkit - A SWIG based wrapper for the EPANET Toolkit. 
+*nrtest-epanet - A plugin for performing numerical regression tests on EPANET (requires epanet-output).
+* ...
 
-Example2.py is example2.c from toolkit help rewritten in Python as example of epamodule use.
+## Motivation
+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.
 
-## outbin
-Python module for reading EpanetBinaryOutputFiles in OO mode
-See help of class EpanetOutBin. 
-At present it is a self contained pure Py module: a partial rewriting is planned
-in a near future for use of outputapi C library.
+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.
+
+## Contributing
+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! 

LICENSE renamed to epanet-module/LICENSE

@@ -0,0 +1,15 @@
+# epanet-python
+python wrapper for epanet library
+Works with both Python 2.7 and 3.x
+
+## epamodule
+A Python module that permits Epanet toolkit library calls from pure Python programs.
+Dropped interface generated by ctypesgen from epanet2.h  (beacause not working with 2.x and 3.x)
+
+Example2.py is example2.c from toolkit help rewritten in Python as example of epamodule use.
+
+## outbin
+Python module for reading EpanetBinaryOutputFiles in OO mode
+See help of class EpanetOutBin. 
+At present it is a self contained pure Py module: a partial rewriting is planned
+in a near future for use of outputapi C library.