GRLP


NameGRLP JSON
Version 1.8.0 PyPI version JSON
download
home_pagehttps://github.com/awickert/GRLP
SummaryEvolves gravel-bed river long profiles
upload_time2023-07-04 14:57:29
maintainer
docs_urlNone
authorAndrew D. Wickert
requires_python
license
keywords fluvial geomorphology sediment transport landscape evolution
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.6968526.svg)](https://doi.org/10.5281/zenodo.6968526)

# 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](https://www.earth-surf-dynam.net/7/17/2019/esurf-7-17-2019.html), *Earth Surf. Dynam.*, *7*, 17–43, doi:10.5194/esurf-7-17-2019.**

Furthermore, if you use any of the features associated with the linearization or the plotting scripts noted in the folder [McNab_et_al_submitted_GRL](https://github.com/MNiMORPH/GRLP/tree/master/examples/McNab_et_al_submitted_GRL), please cite:

**M<sup>c</sup>Nab, F., T. F. Schildgen, J. M. Turowski, and A. D. Wickert (2022, submitted), Diverse responses of alluvial rivers to periodic environmental change.**


## Installation

### Via pip and PyPI

Releases will be sent to [PyPI](https://pypi.org/project/GRLP/).

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](https://github.com/awickert/GRLP/blob/master/example_1d.ipynb). 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](examples/run_network_5_segments_2020.py) 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



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/awickert/GRLP",
    "name": "GRLP",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "fluvial geomorphology sediment transport landscape evolution",
    "author": "Andrew D. Wickert",
    "author_email": "awickert@umn.edu",
    "download_url": "https://files.pythonhosted.org/packages/9e/e5/ddc17020b0fd96e771d2d9a6ed4bc5c498c9857553d17ff5096146b2d782/GRLP-1.8.0.tar.gz",
    "platform": null,
    "description": "[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.6968526.svg)](https://doi.org/10.5281/zenodo.6968526)\n\n# gravel-river-long-profile\nLong-profile evolution of gravel-bed rivers\n\n`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.\n\n\nWhen you use **grlp**, please cite:\n\n**Wickert, A. D. and T. F. Schildgen (2019), [Long-Profile Evolution of Transport-Limited Gravel-Bed Rivers](https://www.earth-surf-dynam.net/7/17/2019/esurf-7-17-2019.html), *Earth Surf. Dynam.*, *7*, 17\u201343, doi:10.5194/esurf-7-17-2019.**\n\nFurthermore, if you use any of the features associated with the linearization or the plotting scripts noted in the folder [McNab_et_al_submitted_GRL](https://github.com/MNiMORPH/GRLP/tree/master/examples/McNab_et_al_submitted_GRL), please cite:\n\n**M<sup>c</sup>Nab, F., T. F. Schildgen, J. M. Turowski, and A. D. Wickert (2022, submitted), Diverse responses of alluvial rivers to periodic environmental change.**\n\n\n## Installation\n\n### Via pip and PyPI\n\nReleases will be sent to [PyPI](https://pypi.org/project/GRLP/).\n\nTo download and install the release version within your python system, use:\n\n```\n# Python 2\npip2 install grlp # Python 2; deprecated :(\n\n# Python 3 (implicit, assuming your packages are updated)\npip install grlp\n\n# Python 3 (explicit)\npip3 install grlp\n```\n\n### Locally with pip and incorporating ongoing code modifications\n\nTo install the unreleased code from this repository and/or to make changes to it locally and have this reflected immediately in how GRLP runs:\n\n```\n# Download the repository\ngh repo clone awickert/GRLP\n\n# Install it\n# First, navigate to the root grlp directory. Then do one or both of:\npip2 install -e . # Python 2; deprecated :(\npip install -e . # Python 3; recommended\npip3 install -e . # Python 3; command to explicitly use this version\n```\n\nOf 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.\n\n## Learning how to use GRLP\n\n### 1-D river long profile\n\nFor a tutorial run the [Jupyter notebook contained within this package](https://github.com/awickert/GRLP/blob/master/example_1d.ipynb). After installing Jupyter on your local machine, navigate to this directory in the terminal and type:\n```\njupyter notebook\n```\nto launch it. Alternatively, a number of cloud-based services can help to host Jupyter notebooks.\n\n### Network of 1-D river long profiles\n\n* A [complete example](examples/run_network_5_segments_2020.py) for a river network, with plotting and descriptions\n* An [example to set up synthetic river networks](https://github.com/awickert/GRLP/blob/master/examples/network_examples/network_examples.py\n\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Evolves gravel-bed river long profiles",
    "version": "1.8.0",
    "project_urls": {
        "Homepage": "https://github.com/awickert/GRLP",
        "Model page": "https://csdms.colorado.edu/wiki/Model:GRLP"
    },
    "split_keywords": [
        "fluvial",
        "geomorphology",
        "sediment",
        "transport",
        "landscape",
        "evolution"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9ee5ddc17020b0fd96e771d2d9a6ed4bc5c498c9857553d17ff5096146b2d782",
                "md5": "76be62121e3a744d3d8de869c25f2a9e",
                "sha256": "6639ba800612c78ea5689ae2b90bd6e72eafb47899736c72d233054274a2e7fd"
            },
            "downloads": -1,
            "filename": "GRLP-1.8.0.tar.gz",
            "has_sig": false,
            "md5_digest": "76be62121e3a744d3d8de869c25f2a9e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 32635,
            "upload_time": "2023-07-04T14:57:29",
            "upload_time_iso_8601": "2023-07-04T14:57:29.830122Z",
            "url": "https://files.pythonhosted.org/packages/9e/e5/ddc17020b0fd96e771d2d9a6ed4bc5c498c9857553d17ff5096146b2d782/GRLP-1.8.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-04 14:57:29",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "awickert",
    "github_project": "GRLP",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "grlp"
}
        
Elapsed time: 0.08458s