tank-model

Python implementation of Tank Hydrological model by Sugawara and Funiyuki (1956)

https://github.com/nzahasan/tank-model

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.1%) to scientific vocabulary

Keywords

hydrologic-model hydrology rainfall-runoff-model tank-hydrologic-model tank-model
Last synced: 8 months ago · JSON representation ·

Repository

Python implementation of Tank Hydrological model by Sugawara and Funiyuki (1956)

Basic Info
  • Host: GitHub
  • Owner: nzahasan
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 23.6 MB
Statistics
  • Stars: 14
  • Watchers: 1
  • Forks: 7
  • Open Issues: 5
  • Releases: 0
Topics
hydrologic-model hydrology rainfall-runoff-model tank-hydrologic-model tank-model
Created about 7 years ago · Last pushed over 1 year ago
Metadata Files
Readme License Citation

readme.md

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

bash $ 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.

```bash

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. bash $ tank_cmd.py new-project project_name

A sample project definition looks like this json { "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" } 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

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

bash $ tank_cmd.py hms2tank -bf hechms_basin_file -of output_tank_basin_file_path

Computing tank model

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

Automatic optimization of tank model

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

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.

Owner

  • Name: Nazmul Ahasan Shawn
  • Login: nzahasan
  • Kind: user
  • Location: Dhaka, Bangladesh
  • Company: @RIMESINT

If you don't eat your meat, you can't have any pudding. How can you have any pudding if you don't eat your meat?

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, kindly cite it as below."
authors:
- family-names: "Shawn"
  given-names: "Nazmul Ahasan"
  orcid: "https://orcid.org/0000-0002-5520-6407"
title: "tank-hydrological-model"
version: 0.2.3
date-released: 2023-05-02
url: "https://github.com/nzahasan/tank-model"

GitHub Events

Total
  • Watch event: 2
Last Year
  • Watch event: 2

Committers

Last synced: about 2 years ago

All Time
  • Total Commits: 100
  • Total Committers: 1
  • Avg Commits per committer: 100.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 31
  • Committers: 1
  • Avg Commits per committer: 31.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Nazmul Ahasan n****n@g****m 100

Issues and Pull Requests

Last synced: over 1 year ago

All Time
  • Total issues: 13
  • Total pull requests: 4
  • Average time to close issues: 6 months
  • Average time to close pull requests: less than a minute
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 0.38
  • Average comments per pull request: 0.0
  • Merged pull requests: 4
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: less than a minute
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • nzahasan (13)
Pull Request Authors
  • nzahasan (4)
  • InterStella0 (1)
Top Labels
Issue Labels
enhancement (2) new-features (1) lazyness-overloaded (1)
Pull Request Labels

Dependencies

requirements.txt pypi
  • click *
  • joblib *
  • matplotlib *
  • numpy *
  • pandas *
  • pyscissor *
  • scipy *
  • seaborn *
  • tabulate *
.github/workflows/python-package.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
setup.py pypi