Model:HydroCNHS

HydroCNHS

Also known as
Model type	Single
Model part of larger framework
Note on status model
Date note status model

Incorporated models or components:

Spatial dimensions	2D
Spatial extent	Landscape-Scale
Model domain	Hydrology
One-line model description	HydroCNHS, a Python Package of Hydrological Model for Coupled Natural–Human Systems
Extended model description	HydroCNHS is an open-source Python package supporting four Application Programming Interfaces (APIs) that enable users to integrate their human decision models, which can be programmed with the agent-based modeling concept, into the HydroCNHS.

Keywords:	Hydrological model, drainage basin, Agent-based modeling,

Supported platforms	Unix, Linux, Mac OS
Other platform
Programming language	Python
Other program language
Code optimized	Multiple Processors
Multiple processors implemented
Nr of distributed processors
Nr of shared processors
Start year development	2021
Does model development still take place?	Yes
If above answer is no, provide end year model development
Code development status	Active
When did you indicate the 'code development status'?	2022
Model availability	As code
Source code availability (Or provide future intension)	Through web repository
Source web address	https://github.com/philip928lin/HydroCNHS
Source csdms web address
Program license type	GPL v3
Program license type other
Memory requirements	--
Typical run time	--

Describe input parameters	(1) Daily climate data including precipitation, temperature, and (optional) potential evapotranspiration (python dictionary object), (2) A model configuration file (.yaml; settings for the HydroCNHS and ABM models), and (3) ABM modules (.py; customized human models).
Input format	ASCII
Other input format
Describe output parameters	The outputs of HydroCNHS are stored in a data collector object, an attribute of HydroCNHS (e.g., model.dc). The main output is the daily streamflow at routing outlets. However, this data collector object will also contain other user-specified agent outputs as long as users use this data collector object in their ABM modules.
Output format	ASCII
Other output format
Pre-processing software needed?	No
Describe pre-processing software
Post-processing software needed?	No
Describe post-processing software
Visualization software needed?	No
If above answer is yes
Other visualization software

Describe processes represented by the model	--
Describe key physical parameters and equations	--
Describe length scale and resolution constraints	--
Describe time scale and resolution constraints	--
Describe any numerical limitations and issues	--

Describe available calibration data sets	See paper that describes the simulation of Tualatin River Basin as a case study. Lin et al., 2022.
Upload calibration data sets if available:
Describe available test data sets	--
Upload test data sets if available:
Describe ideal data for testing	--

Do you have current or future plans for collaborating with other researchers?

Is there a manual available?	Yes
Upload manual if available:
Model website if any	https://hydrocnhs.readthedocs.io/en/latest/index.html
Model forum / discussion board

Comments

This part will be filled out by CSDMS staff

Can be coupled with:

Model info

Authors

Chung-Yi Lin

Yang

Source code

Model citations

QR-code

Link to this page

Other models by author

Featured reference(s)	Open Access Status	Year	Type of Reference	Cited
Lin, C.-Y.; Yang, Y.-C.E.; Wi, S.; 2022. HydroCNHS: A Python Package of Hydrological Model for Coupled Natural–Human Systems. Journal of Water Resources Planning and Management, 148. 10.1061/(ASCE)WR.1943-5452.0001630	closed	2022	a module overview describing a module	3