Skip to content

Latest commit

 

History

History
59 lines (41 loc) · 1.23 KB

README.md

File metadata and controls

59 lines (41 loc) · 1.23 KB

gwlf-e

Port of Generalized Watersheds Loading Functions - Enhanced (MapShed)

Installation

Install using pip:

$ pip install gwlf-e

For Linux x64 on Python 3.8, 3.9, and 3.10 the above will pull a published wheel. For other platforms, a wheel would have to be built. In that case, you may also need to install setuptools, wheel, and build to compile it locally:

$ pip install wheel build
$ pip install --no-build-isolation gwlf-e

Development

Ensure you have Python 3.10 and pipenv available. Then run:

$ pipenv sync --dev
$ pipenv run python setup.py build

Running Locally

$ pipenv run ./run.py --json test/integrationtests/input_4_output.json test/integrationtests/input_4.gms

Testing

$ pipenv run nosetests

Deployments

Create a new release using git flow:

$ git flow release start 3.0.0
$ vim CHANGELOG.md
$ vim setup.py
$ git add CHANGELOG.md setup.py
$ git commit -m "3.0.0"
$ git flow release finish -p 3.0.0

When the tag is pushed up, GitHub Actions will publish a release to PyPI.

License

This project is licensed under the terms of the Apache 2.0 license.