.. hydrocnhs documentation master file, created by
   sphinx-quickstart on Sun Nov  3 00:06:40 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.


HydroCNHS User Manual
=====================================

**The Hydrological model for Coupled Natural-Human Systems (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 (ABM) concept, into the HydroCNHS.

Manual contributors: Chung-Yi Lin & Ali Ghaffari

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   ./files/2_installation
   ./files/3_101_classroom
   ./files/4_input_output
   ./files/5_build_a_hydrological_model
   ./files/6_Integrate_an_ABM
   ./files/7_data_collector
   ./files/8_calibration
   ./files/9_advanced ABM coding tips
   ./api/hydrocnhs

How to cite?
==================
Lin, C. Y., Yang, Y. C. E., & Wi S. (2022). `HydroCNHS: A Python Package of Hydrological Model for Coupled Natural Human Systems <https://doi.org/10.1061/(ASCE)WR.1943-5452.0001630>`_, Journal of Water Resources Planning and Management, 148(12), 6022005.

Related studies
==================
Lin, C. Y., & Yang, Y. E. (2022). `The effects of model complexity on model output uncertainty in co-evolved coupled natural-human systems <https://doi.org/10.1029/2021EF002403>`_. Earth's Future, e2021EF002403.
Lin, C.-Y., Yang, Y. E., & Chaudhary, A. K. (2023). `Pay-for-practice or Pay-for-performance? A coupled agent-based evaluation tool for assessing sediment management incentive policies <https://doi.org/10.1016/j.jhydrol.2023.129959>`_. Journal of Hydrology, 624, 129959.


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`