maxdv / pydeltarcm

Delta model with a reduced-complexity approach

pyDeltaRCM

pyDeltaRCM is the Python version of the Matlab deltaRCM model by Man Liang. The pyDeltaRCM scripts in this repository can be run as a stand-alone model following the instructions below.

This model repository no longer includes support for the Basic Model Interface (BMI). We have separated BMI support for pyDeltaRCM to another repository (the BMI_pyDeltaRCM model).

Documentation

Find the full documentation here.

Installation

To install this package into an existing Python 3.x environment, download or clone the repository and run:

$ python setup.py install

Or for a developer installation run:

$ pip install -e .

Executing the model

We recommend you check out our pyDeltaRCM in 10 minutes tutorial, which is part of our documentation.

Additionally, the model can be run with example script run_pyDeltaRCM.py:

This reads the input file tests/test.yaml and runs a 1 timestep simulation. This script will create an output folder in the working directory and save a PNG file of the parameter eta (surface elevation) every 50 timesteps.