Scribd
Upload
137 views2 pages

Project Overview: Examples

PyFlo is an open-source Python library for stormwater analysis that includes hydraulic grade analysis, storage and flood routing simulations, and basin computations using SCS and Rational methods. It aims to be more powerful through contributions from many developers. The documentation provides instructions for installing, viewing examples of, and contributing to the project on GitHub through forking, cloning, committing, and submitting pull requests. Testing is done using the unittest module.

Uploaded by

P K
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
137 views2 pages

Project Overview: Examples

PyFlo is an open-source Python library for stormwater analysis that includes hydraulic grade analysis, storage and flood routing simulations, and basin computations using SCS and Rational methods. It aims to be more powerful through contributions from many developers. The documentation provides instructions for installing, viewing examples of, and contributing to the project on GitHub through forking, cloning, committing, and submitting pull requests. Testing is done using the unittest module.

Uploaded by

P K
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
You are on page 1/ 2

Project Overview

PyFlo is an open-source library written in Python for performing hydraulic and


hydrology stormwater analysis. Capabilities include network hydraulic grade analysis
and time/iteration based storage and flood routing simulations. SCS Unit Hydrograph
and Rational Method are included for basin computations. Most of the calculations and
procedures are derived from available existing publications and resources. There are
some GUI programs available that have similar capabilities. The intent is that many will
build from and contribute to the project, making it much more powerful than a single
person ever could.

Installation
Installing the easy way, using pip:
$ pip install pyflo

Examples
There are many ways to utilize the PyFlo library. A few examples and tutorials can be
viewed on the EXAMPLES page.

Contributing
For developers, it's important to use common best practices when contributing to the
project. PEP 8 should always be adhered. Code should be documented with Google style
docstrings. Pull requests and filing issues are encouraged.
To start contributing with the PyFlo repository:
1. Fork it!
2. Create a local clone of your fork.
$ git clone https://github.com/YOUR-USERNAME/pyflo
Cloning into `pyflo`...
remote: Counting objects: 10, done.
remote: Compressing objects: 100% (8/8), done.
remove: Total 10 (delta 1), reused 10 (delta 1)
Unpacking objects: 100% (10/10), done.

3. Set up a clean working environment, using virtualenv.


$ virtualenv -p python3 venv
$ source venv/bin/activate
$ pip install -r requirements/development.txt

Page 1|2
4. Add the original as a remote repository named upstream.
$ git remote add upstream https://github.com/benjiyamin/pyflo.git
$ git remote -v
origin https://github.com/YOUR-USERNAME/pyflo.git (fetch)
origin https://github.com/YOUR-USERNAME/pyflo.git (push)
upstream https://github.com/benjiyamin/pyflo.git (fetch)
upstream https://github.com/benjiyamin/pyflo.git (push)

5. Fetch the current upstream repository branches and commits.


$ git fetch upstream
remote: Counting objects: 75, done.
remote: Compressing objects: 100% (53/53), done.
remote: Total 62 (delta 27), reused 44 (delta 9)
Unpacking objects: 100% (62/62), done.
From https://github.com/benjiyamin/pyflo
* [new branch] master -> upstream/master

6. Checkout your local master branch and sync upstream/master to it, without losing
local changes.
$ git checkout master
Switched to branch 'master'

$ git merge upstream/master

7. Commit your local changes and push to upstream/master.


$ git commit -m 'Add some feature'
$ git push upstream master

8. Submit a pull request. =)


For a list of contributors who have participated in this project, check out AUTHORS.

Testing
Unit Testing is currently done using the built-in unittest module:
$ python tests.py

License
This project is licensed under GPL 3.0 - see LICENSE for details.

Page 2|2

You might also like