SMARTcpp: a C++ extension of the rainfall-runoff SMART for Python
Project description
[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![PyPI Version](https://badge.fury.io/py/smartcpp.svg)](https://pypi.python.org/pypi/smartcpp)
# SMARTcpp - a C++ extension of the rainfall-runoff SMART for Python
SMARTcpp is an open-source C++ extension for the hydrological catchment model SMART in Python. It is licensed under GNU GPL-3.0 (see [licence file](LICENCE.md) provided). SMART is a top-down rainfall-runoff model composed of a soil moisture accounting component and a routing component. It requires rainfall and potential evapotranspiration time series, it features a set of ten parameters, and it yields a discharge time series. This C++ extension is giving access to the calculation of the states, processes, and outputs of the model for one simulation time-step. It is intended to be used in combination with a wrapping script in Python, where the loop through the simulation time series is defined.
Mockler, E., O’Loughlin, F., and Bruen, M.: Understanding hydrological flow paths in conceptual catchment models using uncertainty and sensitivity analysis, Computers & Geosciences, 90, 66–77,[doi:10.1016/j.cageo.2015.08.015](https://dx.doi.org/10.1016/j.cageo.2015.08.015), 2016
## How to Install
SMARTcpp is available on PyPI for Python 2.7 and Python 3.6 (both for macOS and Windows), so you can simply use pip:
python -m pip install smartcpp
Alternatively, you can download the source code (i.e. this repository) and use the command:
python setup.py install
## Model Specifications
### Model Inputs
aerial rainfall time series [mm/time step]
potential evapotranspiration time series [mm/time step]
### Model Parameters
T: rainfall aerial correction coefficient [-]
C: evaporation decay parameter [-]
H: quick runoff coefficient [-]
D: drain flow parameter - fraction of saturation excess diverted to drain flow [-]
S: soil outflow coefficient [-]
Z: effective soil depth [mm]
SK: surface routing parameter [hours]
FK: inter flow routing parameter [hours]
GK: groundwater routing parameter [hours]
RK: river channel routing parameter [hours]
### Model Outputs
discharge time series at catchment outlet [m<sup>3</sup>/s]
## Version History
- 0.1.1 [18 Jul 2018]: Version with proper PyPI display
Fixes display issue of README.md on PyPI
0.1.0 [09 Jul 2018]: First version of SMARTcpp
## Acknowledgment
This tool was developed with the financial support of Ireland’s Environmental Protection Agency (Grant Number 2014-W-LS-5).
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for smartcpp-0.1.1-cp36-cp36m-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bc5802f11a5ed84d4617b2b5c2469b66401aadeaab788a837d113029c36dee15 |
|
MD5 | 1dde75fe9698c59a05ff77fc30c7fb5d |
|
BLAKE2b-256 | f34d39cce9803d9e90658f722b4d8812b1f50c0c88818c03a16523f89b91cf4e |
Hashes for smartcpp-0.1.1-cp36-cp36m-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 16610a961d56616c386fa466b3181ba7457c504f26c3b8f6c34639cb8545bce9 |
|
MD5 | 2e7f020b8e28afed2ba5742aa1ce7aad |
|
BLAKE2b-256 | 7438479fca9363d3b733ad62647b48f7520e995c1234952a5115c4c7826e01b1 |
Hashes for smartcpp-0.1.1-cp27-cp27m-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4c59f299102e1309cbbf705f8518cd7c3a0cbe6c88b2231e7a1aa2fbab769a6d |
|
MD5 | 1621b8a2807b978c7ba96f65b47dca07 |
|
BLAKE2b-256 | 834567c1f17ca850d8f4c158d46b62d43022b93f46a7fba168632ea32e3683b4 |
Hashes for smartcpp-0.1.1-cp27-cp27m-macosx_10_6_intel.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a5039419dfdbaac410fb58097505f0f7b8f62435b462ca1f43d923208363fc45 |
|
MD5 | 25d7a8b9b1c509d631001f12b050b7a2 |
|
BLAKE2b-256 | c20d23d3c548881523caa3737914871f9a4f79fe37e0b24ebd726041fdde57c5 |