Skip to content

Python Model API for RHESSys (The Regional Hydro-Ecologic Simulation System) model

License

Notifications You must be signed in to change notification settings

uva-hydroinformatics/pyRHESSys

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

pyrhessys

pyrhessys Links & Badges
pyRHESSys Tutorial Binder
pyRHESSys Documentation Documentation Status

pyrhessys (Python-the Regional Hydro-Ecologic Simulation System) is an Object-Oriented Python wrapper for the model input creation and manipulation, model execution, model output visualization and analysis.

pyrhessys provides methods for:

  • Get and set model input
  • Run the RHESSys Model on local computers and scientific cyberinfrastructures (especially, CyberGIS-Jupyter for water)
  • Visualize RHESSys outputs (In progress)
  • Be integrated with pyrhessys with Jupyter Notebook environment
  • Interact with Hydorshare to download RHESSys test cases and upload RHESSys outputs
  • Create model input using GRASS GIS and R library (in progress)
  • Automate model calibration or sensitivity analysis (Future work)

Installation

pyrhessys can be installed from pip.

To install via pip use:

pip install pyrhessys

RHESSys can be installed from 'conda' (in progress)

To install via 'conda' use:

conda install -c conda-forge rhessysec

Installing pyrhessys from source

Installing pyrhessys from source can be useful for developing new features. This can be accomplished by running:

git clone https://github.com/DavidChoi76/pyrhessys.git
cd pyrhessys
conda env create -f environment.yml
python -m ipykernel install --user --name=pyrhessys
pip install .

Bugs

Our issue tracker is at https://github.com/DavidChoi76/pyrhessys/issues. Please report any bugs that you find. Or, even better, fork the repository on GitHub and create a pull request. All changes are welcome, big or small, and we will help you make the pull request if you are new to git (just ask on the issue).

License

Distributed with a MIT license; see LICENSE.txt::

Copyright (C) 2020 pyrhessys Developers YoungDon Choi <choiyd1115@gmail.com or yc5ef@virginia.edu>

About

Python Model API for RHESSys (The Regional Hydro-Ecologic Simulation System) model

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published