Skip to content

Latest commit

 

History

History
58 lines (43 loc) · 2.42 KB

README.md

File metadata and controls

58 lines (43 loc) · 2.42 KB
Raw

alt text
alt text Funding for this project was provided by the National Oceanic & Atmospheric Administration (NOAA), awarded to the Cooperative Institute for Research to Operations in Hydrology (CIROH) through the NOAA Cooperative Agreement with The University of Alabama (NA22NWS4320003).

TEEHR - Tools for Exploratory Evaluation in Hydrologic Research

TEEHR (pronounced "tier") is a python tool set for loading, storing, processing and visualizing hydrologic data, particularly National Water Model data, for the purpose of exploring and evaluating the datasets to assess their skill and performance.

NOTE: THIS PROJECT IS UNDER DEVELOPMENT - EXPECT TO FIND BROKEN AND INCOMPLETE CODE.

Documentation

TEEHR Documentation

How to Install TEEHR

Install poetry

$ pipx install poetry

Install from source

# Create and activate python environment, requires python >= 3.10
$ poetry shell

# Install from source
$ poetry install

Install from GitHub

# Using pip
$ pip install 'teehr @ git+https://github.com/RTIInternational/teehr@[BRANCH_TAG]'

# Using poetry
$ poetry add git+https://github.com/RTIInternational/teehr.git#[BRANCH TAG]

Use Docker

$ docker build -t teehr:v0.3.24 .
$ docker run -it --rm --volume $HOME:$HOME -p 8888:8888 teehr:v0.3.24 jupyter lab --ip 0.0.0.0 $HOME

Examples

For examples of how to use TEEHR, see the examples. We will maintain a basic set of example Jupyter Notebooks demonstrating how to use the TEEHR tools.

Resources

In May of 2023 we put on a workshop at the CIROH 1st Annual Training and Developers Conference. The workshop materials and presentation are available in the workshop GitHub repository: teehr-may-2023-workshop. This workshop was based on version 0.1.0.

Versioning

The TEEHR project follows semantic versioning as described here: https://semver.org/. Note, per the specification, "Major version zero (0.y.z) is for initial development. Anything MAY change at any time. The public API SHOULD NOT be considered stable.". We are solidly in "major version zero" territory, and trying to move fast, so expect breaking changes often.