topmodelpy is a rainfall-runoff model that predicts the amount of water flow in rivers. topmodelpy is a command line application written in Python using Click, and is a complete conversion of the original rainfall-runoff model, called Topmodel, from Fortran to Python. The specific version of Topmodel that topmodelpy is based on is the version by David Wolock, U.S. Geological Survey. Please see report below for more details:
Wolock, D.M., "Simulating the variable-source-area concept of streamflow generation with the watershed model Topmodel", U.S. Geological Survey, Water-Resources Investigations Report 93-4124, 1993.
- Written entirely in Python for ease of use and model extension.
Add a short example
show some example code here
Add a link to the project and code documenation site.
A suite of tests were built using pytest.
To run the test suite, from the command line in the project's root directory:
$ py.test tests/
Add requirements and code dependencies.
To install topmodelpy from source:
Check that you have Python installed:
$ python --version
If you do not have Python installed, please download the latest version from Python's download page
Download topmodelpy from the repository and extract to a directory of your choice.
Or, if you have git installed you can clone the project:
$ git clone <remote url to topmodelpy>
Navigate to the project's root directory where the setup script called setup.py is located:
$ cd topmodelpy/
Run setup.py with the install command:
$ python setup.py install
topmodelpy will now be installed to the standard location for third-party Python modules on your computer platform.
For more information regarding installing third-party Python modules, please see Installing Python Modules For a description of how installation works including where the module will be installed on your computer platform, please see How Installation Works.
This software is licensed under CC0 1.0 and is in the public domain because it contains materials that originally came from the U.S. Geological Survey (USGS), an agency of the United States Department of Interior. For more information, see the official USGS copyright policy.
This software is preliminary or provisional and is subject to revision. It is being provided to meet the need for timely best science. The software has not received final approval by the U.S. Geological Survey (USGS). No warranty, expressed or implied, is made by the USGS or the U.S. Government as to the functionality of the software and related material nor shall the fact of release constitute any such warranty. The software is provided on the condition that neither the USGS nor the U.S. Government shall be held liable for any damages resulting from the authorized or unauthorized use of the software.
The USGS provides no warranty, expressed or implied, as to the correctness of the furnished software or the suitability for any purpose. The software has been tested, but as with any complex software, there could be undetected errors. Users who find errors are requested to report them to the USGS.
References to non-USGS products, trade names, and (or) services are provided for information purposes only and do not constitute endorsement or warranty, express or implied, by the USGS, U.S. Department of Interior, or U.S. Government, as to their suitability, content, usefulness, functioning, completeness, or accuracy.
Although this program has been used by the USGS, no warranty, expressed or implied, is made by the USGS or the United States Government as to the accuracy and functioning of the program and related program material nor shall the fact of distribution constitute any such warranty, and no responsibility is assumed by the USGS in connection therewith.
This software is provided "AS IS."
Jeremiah Lant <[email protected]>