Introduction

Last Updated: April 10, 2017

GsshaPy is an object relational model (ORM) for the Gridded Surface Subsurface Hydrologic Analysis (GSSHA) model and a toolkit to convert gridded input into GSSHA input. The purpose of GsshaPy is to expose GSSHA files to a web development environment by reading them into an SQL database. The files can also be written back to file for model execution. GsshaPy is built on top of the powerful SQLAlchemy ORM.

https://zenodo.org/badge/26494532.svg

What is GSSHA?

GSSHA is a physically-based, distributed hydrologic model. GSSHA is developed and maintained by Coastal and Hydraulics Laboratory (CHL) which is a member of the Engineer Research & Development Center of the United States Army Corps of Engineers (USACE). GSSHA is used to predict soil moisture as well as runoff and flooding on watersheds.

Note

For more information about GSSHA please visit the the gsshawiki .

Installation

Note

The spatial components of GsshaPy can rely heavily on the PostGIS spatial extension for the PostgreSQL database. To work with spatial data in GsshaPy you will need to use a PostgreSQL database with PostGIS 2.1 or greater enabled.

Linux/Mac

Download Miniconda & Install Miniconda

See: https://conda.io/miniconda.html

Install Miniconda

$ chmod +x miniconda.sh
$ ./miniconda.sh -b
$ export PATH=$HOME/miniconda2/bin:$PATH
$ conda update --yes conda python

Install gsshapy

$ conda create --name gssha python=2
$ source activate gssha
$ conda config --add channels conda-forge
(gssha)$ conda install --yes gsshapy

Install gsshapy for development:

$ git clone https://github.com/CI-WATER/gsshapy.git
$ cd gsshapy
$ conda env create -f conda-env.yml
$ source activate gssha
(gssha)$ conda config --add channels conda-forge
(gssha)$ conda install --yes pynio
(gssha)$ python setup.py develop

Note

When using a new terminal, always type source activate gssha before using GsshaPy.

Windows

Note

pynio installation instructions are not provided for Windows, so HRRRtoGSSHA() will not work.

Download & Install Miniconda

  • Go to: http://conda.pydata.org/miniconda.html
  • Download and run Windows Python 2 version installer
  • Install at C:\Users\YOUR_USERNAME\Miniconda2 or wherever you want
  • During installation, make Miniconda the default python and export to path

Install gsshapy:

Open up the CMD program. Then, enter each line separately.

> conda update --yes conda python
> conda create --name gssha python=2
> activate gssha
(gssha)> conda config --add channels conda-forge
(gssha)> conda install --yes gsshapy

Install gsshapy for development:

Download the code for gsshapy from https://github.com/CI-WATER/gsshapy or clone it using a git program.

Open up the CMD program. Then, enter each line separately.

> cd gsshapy
> conda env create -f conda-env.yml
> activate gssha
(gssha)> conda config --add channels conda-forge
(gssha)> python setup.py develop

Note

When using a new CMD terminal, always type activate gssha before using GsshaPy.

License

GsshaPy is released under the BSD 3-Clause license.

Source

The source code is available on GitHub: https://github.com/CI-WATER/gsshapy.git

Authors

Nathan Swain, Alan D. Snow, and Scott D. Christensen.

NSF Grant

GsshaPy was developed at Brigham Young University with support from the National Science Foundation (NSF) under Grant No. 1135482. GsshaPy is part of a larger effort known as CI-Water. The purpose of CI-Water is to develop cyber infrastructure for water resources decision support.