PRMS-Python provides a Python interface to PRMS data files and for running PRMS simulations. This module tries to improve the management of PRMS simulation data while also providing useful "pythonic" tools to do scenario-based PRMS simulations. By "scenario-based" modeling we mean, for example, parameter sensitivity analysis, where each "scenario" is an iterative perturbation of one or many parameters. Another example "scenario-based" modeling exercise would be climate scenario modeling: what will happen to modeled outputs if the input meteorological data were to change?

Currently it's clone-then-pip:

git clone https://github.com/JohnVolk/PRMS-Python.git

then

pip install --editable .

This project uses the Sphinx documentation engine for Python The documentation source is located in docs/source. Eventually we can wrap the following steps into a script. But for now, to build the documentation, go to the docs/ directory and run

make html

If it fails because of missing dependencies, just install the dependencies it says it's missing. I don't know why it's asking for some dependencies right now.

Please read the Online Documentation and view the included Jupyter notebooks for further documentation and examples.

I run them using nose but that's not required. From the root repo directory

nosetests -v