From b15fe79d14a9549fe110a397be63caa9e95607b9 Mon Sep 17 00:00:00 2001 From: Sam Rensenhouse Date: Thu, 10 Mar 2022 13:23:53 -0500 Subject: [PATCH 1/3] Updating EPANET submodule to latest dev --- owa-epanet/EPANET | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/owa-epanet/EPANET b/owa-epanet/EPANET index d11907a..d5c9a95 160000 --- a/owa-epanet/EPANET +++ b/owa-epanet/EPANET @@ -1 +1 @@ -Subproject commit d11907a2b03213f948fbd502a86bc8f06007a3df +Subproject commit d5c9a95c5f085069fe2de893abefcc38a85b1c25 From c74abadbd2dc7b2c13207495f72546d4dde3dc6a Mon Sep 17 00:00:00 2001 From: Sam Rensenhouse Date: Thu, 10 Mar 2022 13:35:51 -0500 Subject: [PATCH 2/3] adding installation instructions and more info about package versioning --- owa-epanet/README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/owa-epanet/README.md b/owa-epanet/README.md index 6971d15..dd940ca 100644 --- a/owa-epanet/README.md +++ b/owa-epanet/README.md @@ -4,6 +4,14 @@ A slender, auto-generated python wrapper around the owa:epanet hydraulic network Where possible, SWIG has been configured to throw warnings/exceptions instead of using the customary EPANET return integer value for success-checking. Also any output (pointer) parameters from the C API have been re-routed to return values. In these cases, the return tuple from the Python API will contain the values desired. +## Installation +To install with pip: +```shell +pip install owa-epanet +``` + +Wheels are now provided for most installations, some extra work will be needed if installing from source. + ## Building the libraries @@ -27,3 +35,6 @@ This python library was packaged in the following way: python3 setup.py sdist bdist_wheel python3 -m twine upload dist/* ``` + +## Versioning +This package loosely follows EPANET's release version numbers. Its major and minor numbers will correspond to the given EPANET version, but the patch number is independent. This system might change in the future. From a7a68c466a9e32b7d8d6d474d5d219a3665ed4e6 Mon Sep 17 00:00:00 2001 From: Sam Rensenhouse Date: Thu, 10 Mar 2022 13:36:39 -0500 Subject: [PATCH 3/3] Bumping package to 2.2.4 for submodule changes. 2.2.3 was released but never got into source control and so is skipped here --- owa-epanet/setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/owa-epanet/setup.py b/owa-epanet/setup.py index 45b5ec6..d74768f 100644 --- a/owa-epanet/setup.py +++ b/owa-epanet/setup.py @@ -6,7 +6,7 @@ setup( name = "owa-epanet", - version = "2.2.2", + version = "2.2.4", author = "Sam Hatchett", author_email = "samhatchett@gmail.com", description = "a thin wrapper for epanet hydraulic toolkit",