Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Tank Hydrologic Model

Python implementation of Tank Hydrologic Model, a conceptual rainfall-runoff model proposed by Sugawara and Funiyuki (1956)

Installation

Tank-Model can be installed as a python package using the following commands

$ pip install https://github.com/nzahasan/tank-model/zipball/master

after successful installation tank_cmd.py should be available which can be used for setting up new project, optimizing the project and computation.

# get help text command line utility
$ tank_cmd.py --help

# get help text of subcommand
$ tank_cmd.py new-project --help

Setting up a new model:

New project can be created using the following command. This command creates a folder in working directory with a json formatted project definition inside it.

$ tank_cmd.py new-project project_name

A sample project definition looks like this

{
  "interval": 24.0,
  "basin": "sample_project.basin.json",
  "precipitation": "sample_project.pr.csv",
  "evapotranspiration": "sample_project.et.csv",
  "discharge": "sample_project.q.csv",
  "result": "sample_project.result.csv",
  "statistics": "sample_project.stats.json",
  "start": "2020-01-01T00:00:00",
  "end": "2020-12-31T00:00:00"
}

here interval is the time step of simulation in hours. The other attributes are file locations; precipitation, evapotranspiration and discharge are CSV files containing time-series data. These files should be formatted according to the file format mentioned here file-format-spec.md

start and end are optional and restrict compute, optimize and plot-result to the given date range (format %Y-%m-%dT%H:%M:%S, matching the time-series files). If omitted, the full period available in the input files is simulated; either one can be given on its own, in which case the other side of the range is left unbounded.

precipitation & evapotranspiration serve as input data for the model simulation and resulting output is stored in the result file following the time-series CSV format mentioned earlier. Data in the discharge is used for model calibration. And performance matrices are stored in the statistics file.

Converting HEC-HMS basin to tank model basin

$ tank_cmd.py hms2tank -bf hechms_basin_file -of output_tank_basin_file_path

Computing tank model

$ tank_cmd.py compute -pf project_name.project.json

Automatic optimization of tank model

$ tank_cmd.py optimize -pf project_name.project.json

Known Limitions

  • Currently there is no way to optimize for multiple root node

References:

1. Paik K., Kim J. H., Kim H. S., Lee D. R. (2005) A conceptual rainfall-runoff model considering seasonal variation.
2. Aguilar C., Polo M. J. (2011) Generating reference evapotranspiration surfaces from the Hargreaves equation at watershed scale.
3. Taib A. T. M., Tahir W., Ramli S., Mohtar I. S. A. (2022) Hydro-Meteorological Flood Forecasting Using Tank Model With Satellite-Based Rainfall Input For Kemaman River Catchment.
4. D. N. Moriasi, J. G. Arnold, M. W. Van Liew, R. L. Bingner, R. D. Harmel, T. L. Veith (2007) Model Evaluation Guidelines For Systematic Quantification Of Accuracy In Watershed Simulations.

Metadata

Release files for tank-model 3.0.0b3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for tank-model 3.0.0b3
File Size Uploaded
tank_model-3.0.0b3.tar.gz 21.3 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for tank-model 3.0.0b3
File Interpreter ABI Platform
tank_model-3.0.0b3-py3-none-any.whl Python 3 none any Details

Total release size: 21.4 MB

Release files / tank_model-3.0.0b3.tar.gz

Download URL tank_model-3.0.0b3.tar.gz
Size 21.3 MB
Tags Source
SHA-256 checksum
How to use checksums
0c20c66286422fe5156b1eaf5103f9eead8e6b58b30e3b242b3ac420b6d2cf04
BLAKE2b-256 checksum
How to use checksums
1404c931f880b0b7923fa064b87250e15f84921416da0dcf8f000fc524eed524
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 15, 2026.

Transparency log

Release files / tank_model-3.0.0b3-py3-none-any.whl

Download URL tank_model-3.0.0b3-py3-none-any.whl
Size 27.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e0557b6f1a2d427a563743c9592f09df56e4f7b05d640cb682a379ab511574aa
BLAKE2b-256 checksum
How to use checksums
16076e4b0ffc8a3c34e7bf715b504bcf922dacac2db8aa1f9917597a6672b8dc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 15, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

3.0.0b3 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page