shetranio

A python package to complement the SHETran hydrological model.


License
MIT
Install
pip install shetranio==0.4.1

Documentation

SHETran I/O

Installation

pip install shetranio

Dependencies

  • h5py
  • pandas
  • beautifulsoup4

All core dependencies are included with the default Anaconda distribution (https://docs.anaconda.com/anaconda/install/windows/). To easily install shetranio and dependencies into a new environment:

conda env create -f https://github.com/nclwater/shetranio/blob/master/environment.yml
conda activate shetranio

Optional dependencies

Some features also require gdal and netCDF4. It is recommended to install these using conda.

Usage

from shetranio import Model

model = Model('library_file.xml')
values = model.hdf.overland_flow.get_element(100)
times = model.hdf.overland_flow.times

An example Jupyter notebook is available at https://github.com/nclwater/shetranio/blob/master/docs/notebooks/plotting-discharge-and-groundwater-depth.ipynb