GRLP 1.6.0

Evolves gravel-bed river long profiles

gravel-river-long-profile

Long-profile evolution of gravel-bed rivers

grlp.py is module that contains the equations and solvers. run_grlp.py interfaces with these to, well, run a model based off of grlp.py. Comments inside run_grlp.py should help you learn how to write your own models. Please contact Andy Wickert for questions or assistance.

When you use grlp, please cite:

Wickert, A. D. and T. F. Schildgen (2019), Long-Profile Evolution of Transport-Limited Gravel-Bed Rivers, Earth Surf. Dynam., 7, 17–43, doi:10.5194/esurf-7-17-2019.

Installation

Via pip and PyPI

Releases will be sent to PyPI.

To download and install the release version within your python system, use:

# Python 2
pip2 install grlp # Python 2; deprecated :(

# Python 3 (implicit, assuming your packages are updated)
pip install grlp

# Python 3 (explicit)
pip3 install grlp

Locally with pip and incorporating ongoing code modifications

To install the unreleased code from this repository and/or to make changes to it locally and have this reflected immediately in how GRLP runs:

# Download the repository
gh repo clone awickert/GRLP

# Install it
# First, navigate to the root grlp directory. Then do one or both of:
pip2 install -e . # Python 2; deprecated :(
pip install -e . # Python 3; recommended
pip3 install -e . # Python 3; command to explicitly use this version

Of course, you may always just download the grlp source from here and run it as a local (rather than system-wide installed) module. But this can be inconvenient when needing to manage the directory of grlp.py relative to that of the driver *.py file that you are building to create your model run.

Learning how to use GRLP

1-D river long profile

For a tutorial run the Jupyter notebook contained within this package. After installing Jupyter on your local machine, navigate to this directory in the terminal and type:

jupyter notebook

to launch it. Alternatively, a number of cloud-based services can help to host Jupyter notebooks.

Network of 1-D river long profiles

• A complete example for a river network, with plotting and descriptions
• An [example to set up synthetic river networks](https://github.com/awickert/GRLP/blob/master/examples/network_examples/network_examples.py