Skip to content

README.md

Latest commit

 

History

History
64 lines (45 loc) · 1.86 KB

README.md

File metadata and controls

64 lines (45 loc) · 1.86 KB
Raw

WEPPCLIFF (Python)

Python port of WEPPCLIFF — a command-line tool for preparing climate inputs for WEPP, quality checking, gap filling, and erosion-index calculations (USLE-family models). The original R software was published in the Journal of Open Source Software DOI.

Documentation

User and developer documentation lives in Documentation/:

Document Description
Manual.md CLI flags, arguments, and usage
Tutorial/ Step-by-step tutorial and AutoTutorial.sh
Planning/ Implementation plans and agent guide

Install

From the repository root:

bash Installer/Install.sh

Or manually:

python3 -m venv .venv
. .venv/bin/activate
pip install -r requirements.txt   # pulls PyMICE from github.com/ryanpmcg/PyMICE
pip install -e .

Requires Python 3.10+.

Quick start

.venv/bin/python weppcliff.py -f ASOS_BPT_KMQE.csv -la y

Tutorial, autotest, and tests

bash Tutorial/AutoTutorial.sh
bash Autotest/AutoTest.sh
.venv/bin/python -m pytest Development/tests/

Development tooling (scripts, reports, launchers) is described in Development/README.md.

Repository layout

Source/                              # production code
Input/  Export/  Output/  Plots/   # runtime directories
Tutorial/                            # step-by-step tutorial and AutoTutorial.sh
Documentation/                       # manual and planning docs
Development/                         # tests, scripts, reports
Installer/  Autotest/
weppcliff.py                         # CLI entry point

License

GPL-3.0-or-later — see LICENSE.