[](https://zenodo.org/badge/latestdoi/261265317)
# :otter: OTTAR
Ode To Transient Ancho de los Rivers
Transiently evolving river-channel width as a function of streambank properties, sediment in transport, and the hydrograph.
## Purpose
This model is designed to compute the rates of river-channel widening and narrowing based on changing hydrological regimes. It is currently designed for rivers with cohesive banks, with a critical shear stress for particle detachment and an erosion-rate coefficient.
## Installation
From PyPI:
```sh
pip install ottar
```
Locally, inside a clone of this git repository (the `-e` permits you to make local updates to the code and have them incorporated into the way that OTTAR runs):
```sh
pip install -e .
```
## Structure
OTTAR contains:
* The `RiverWidth` class, which contains methods to evolve the width of an alluvial river.
* The `FlowDepthDoubleManning` class, which is used to estimate flow depth from discharge, even with an evolving river-channel geometry.
## Examples
There's a [folder for these](https://github.com/MNiMORPH/OTTAR/tree/master/examples)!
## Model inputs and outputs
### Inputs
#### Key input parameters (RiverWidth)
| **Variable** | **Description** | **Typical value(s)** |
|------------------ |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |----------------------------- |
| `h_banks` | **Stream-bank height**. This is the thickness of material that must be removed for the river to widen by one unit lateral distance. | 1-5 m |
| `S` | **Channel downstream-directed slope**. This is used to compute shear stresses and (if necessary) flow depth from water discharge. | 10<sup>−3</sup> |
| `b0` | **Initial width**. Starting width of a channel. | 1–1000 m |
| `tau_crit` | **Critical shear stress required to start eroding muddy banks**. At this stress, the flow begins to be able to detach particles. When set up to perform an **inversion** using data on river widening and past flows, this is one of two key parameters to be estimated for rivers with detachment-limited banks. | 1–10 Pa |
| `tau_star_crit_sed` | **Critical shear stress required initiate sediment motion**. This defaults to 0.0495 from the Wong & Parker (2006) rebuild of the Meyer-Peter & Müller (1948) sediment-transport equation. | 0.03–0.06 |
| `k_d` | **Cohesive-detachment erosion-rate coefficient**. This determines the rate of erosion as a function of shear stress above critical. When set up to perform an **inversion** using data on river widening and past flows, this is the other of two key parameters to be estimated. | ~10<sup>−7</sup> m / (Pa s) |
| `k_E` | **Noncohesive erosion-rate (entrainment) coefficient**. This relates theoretical sediment entrainment rate via near-bank Shields stress to bank-retreat rate via erosion. | ~0.01–1 |
| `f_stickiness` | **Fraction of suspended-load particles contacting the bank that "stick" to it**. This modulates the turbulence-driven lateral-transport term and its impact on channel-narrowing rate, and comprises the abillity of banks to trap sediment and to hold it. | 0–1 |
| `k_n_noncohesive` | **Narrowing coefficient (noncohesive sediment)**. Trapping and holding efficiency in regards to noncohesive sediment; this may be due to deep pits between grains and/or other bank-rougness properties. | 0–1 |
| `Parker_epsilon` | **Excess bed shear-stress factor**. $\tau_b = (1+\epsilon) \tau_\beta$, where $\tau_b$ is bed shear stress and $\tau_\beta$ is bank shear stress. | 0.2 |
| `intermittency` | **Intermittency**. Fraction of the time that the discharge given is active. This is always equal to 1 for a full hydrograph, and is $\leq$ 1 when a characteristic "geomorphically effective" discharge is considered. It can be thought of as a time-dialation factor. | 10<sup>−3</sup>–1 |
| `D` | **Sediment median grain size**. This is the median size of the material both in transport and in the banks, and is required for bedload and/or noncohesive-sediment-dominated systems. It may also be specified for rivers dominated by susepended load and bank cohesion, though will likely play a more minor role in these. | 10<sup>−4</sup>–1 m |
#### Key input data sets and parameters (FlowDepthDoubleManning)
*This step is used to compute flow depths from a discharge time series, and may be skipped if you already posess a time series of flow depth*
* Discharge time series
* Manning's n (channel)
* Roughness / topogrpahy coefficient (floodplains)
* Depth / topography exponent (floodplains)
### Outputs
This program outputs a time series of channel width, `b(t)`. It organizes this within a Pandas DataFrame that can also be exported using the `write_csv()` function within the `RiverWidth` class.
Plots can also be made of just river width (`plotb()`) or of discharge and river width (`plotQb`).
Raw data
{
"_id": null,
"home_page": "https://github.com/MNiMORPH/ottar",
"name": "OTTAR",
"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/b9/67/0e3f230641e5d2908473605a70ee311e5da4c64337e19aace5468975b689/OTTAR-0.5.0.tar.gz",
"platform": null,
"description": "[](https://zenodo.org/badge/latestdoi/261265317)\n\n# :otter: OTTAR\n\nOde To Transient Ancho de los Rivers\n\nTransiently evolving river-channel width as a function of streambank properties, sediment in transport, and the hydrograph.\n\n## Purpose\n\nThis model is designed to compute the rates of river-channel widening and narrowing based on changing hydrological regimes. It is currently designed for rivers with cohesive banks, with a critical shear stress for particle detachment and an erosion-rate coefficient.\n\n## Installation\n\nFrom PyPI:\n```sh\npip install ottar\n```\n\nLocally, inside a clone of this git repository (the `-e` permits you to make local updates to the code and have them incorporated into the way that OTTAR runs):\n```sh\npip install -e .\n```\n\n## Structure\n\nOTTAR contains:\n\n* The `RiverWidth` class, which contains methods to evolve the width of an alluvial river.\n* The `FlowDepthDoubleManning` class, which is used to estimate flow depth from discharge, even with an evolving river-channel geometry.\n\n## Examples\n\nThere's a [folder for these](https://github.com/MNiMORPH/OTTAR/tree/master/examples)!\n\n## Model inputs and outputs\n\n### Inputs\n\n#### Key input parameters (RiverWidth)\n\n| **Variable** \t| **Description** \t| **Typical value(s)** \t|\n|------------------\t|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\t|-----------------------------\t|\n| `h_banks` \t | **Stream-bank height**. This is the thickness of material that must be removed for the river to widen by one unit lateral distance. \t| 1-5 m \t|\n| `S` \t | **Channel downstream-directed slope**. This is used to compute shear stresses and (if necessary) flow depth from water discharge. \t| 10<sup>−3</sup> \t|\n| `b0` \t | **Initial width**. Starting width of a channel. \t| 1–1000 m \t|\n| `tau_crit` \t | **Critical shear stress required to start eroding muddy banks**. At this stress, the flow begins to be able to detach particles. When set up to perform an **inversion** using data on river widening and past flows, this is one of two key parameters to be estimated for rivers with detachment-limited banks. \t| 1–10 Pa \t|\n| `tau_star_crit_sed` | **Critical shear stress required initiate sediment motion**. This defaults to 0.0495 from the Wong & Parker (2006) rebuild of the Meyer-Peter & M\u00fcller (1948) sediment-transport equation. \t| 0.03–0.06 \t|\n| `k_d` \t | **Cohesive-detachment erosion-rate coefficient**. This determines the rate of erosion as a function of shear stress above critical. When set up to perform an **inversion** using data on river widening and past flows, this is the other of two key parameters to be estimated. \t| ~10<sup>−7</sup> m / (Pa s) \t|\n| `k_E` \t | **Noncohesive erosion-rate (entrainment) coefficient**. This relates theoretical sediment entrainment rate via near-bank Shields stress to bank-retreat rate via erosion. \t| ~0.01–1 |\n| `f_stickiness` | **Fraction of suspended-load particles contacting the bank that \"stick\" to it**. This modulates the turbulence-driven lateral-transport term and its impact on channel-narrowing rate, and comprises the abillity of banks to trap sediment and to hold it. \t| 0–1 \t|\n| `k_n_noncohesive` | **Narrowing coefficient (noncohesive sediment)**. Trapping and holding efficiency in regards to noncohesive sediment; this may be due to deep pits between grains and/or other bank-rougness properties. \t| 0–1 \t|\n| `Parker_epsilon` | **Excess bed shear-stress factor**. $\\tau_b = (1+\\epsilon) \\tau_\\beta$, where $\\tau_b$ is bed shear stress and $\\tau_\\beta$ is bank shear stress. \t| 0.2 \t|\n| `intermittency` | **Intermittency**. Fraction of the time that the discharge given is active. This is always equal to 1 for a full hydrograph, and is $\\leq$ 1 when a characteristic \"geomorphically effective\" discharge is considered. It can be thought of as a time-dialation factor. \t| 10<sup>−3</sup>–1 \t|\n| `D` \t | **Sediment median grain size**. This is the median size of the material both in transport and in the banks, and is required for bedload and/or noncohesive-sediment-dominated systems. It may also be specified for rivers dominated by susepended load and bank cohesion, though will likely play a more minor role in these.\t| 10<sup>−4</sup>–1 m \t|\n\n#### Key input data sets and parameters (FlowDepthDoubleManning)\n\n*This step is used to compute flow depths from a discharge time series, and may be skipped if you already posess a time series of flow depth*\n\n* Discharge time series\n* Manning's n (channel)\n* Roughness / topogrpahy coefficient (floodplains)\n* Depth / topography exponent (floodplains)\n\n### Outputs\n\nThis program outputs a time series of channel width, `b(t)`. It organizes this within a Pandas DataFrame that can also be exported using the `write_csv()` function within the `RiverWidth` class.\n\nPlots can also be made of just river width (`plotb()`) or of discharge and river width (`plotQb`).\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Ode To Transient Ancho de los Rivers: Transient evolution of river-channel width",
"version": "0.5.0",
"project_urls": {
"CSDMS repository": "https://csdms.colorado.edu/wiki/Model:OTTAR",
"DOI": "https://dx.doi.org/10.5281/zenodo.5124965",
"Homepage": "https://github.com/MNiMORPH/ottar",
"Source and README": "https://github.com/MNiMORPH/OTTAR",
"Zenodo": "https://zenodo.org/record/5781792/export/dcat#.Yme_nIyxXCK"
},
"split_keywords": [
"fluvial",
"geomorphology",
"sediment",
"transport",
"landscape",
"evolution"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9d3602aeb595208e08c5f7e92d539190e1c0cfa49ab3ffadf700eace232e7323",
"md5": "5c46a54c3eb2e3039a6008b137cc3271",
"sha256": "540534c547f805fe2940a0cb9f7bf4a57ffb10d58b5608ccb3644aa63c35966b"
},
"downloads": -1,
"filename": "OTTAR-0.5.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "5c46a54c3eb2e3039a6008b137cc3271",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 25257,
"upload_time": "2023-07-18T11:39:02",
"upload_time_iso_8601": "2023-07-18T11:39:02.871858Z",
"url": "https://files.pythonhosted.org/packages/9d/36/02aeb595208e08c5f7e92d539190e1c0cfa49ab3ffadf700eace232e7323/OTTAR-0.5.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b9670e3f230641e5d2908473605a70ee311e5da4c64337e19aace5468975b689",
"md5": "b3a8ae349189e982de350086e8a6347b",
"sha256": "5b9fad72505eb266cda4513bb24cf13fca58ebc4263038c1e82506d50da70ddc"
},
"downloads": -1,
"filename": "OTTAR-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "b3a8ae349189e982de350086e8a6347b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 25328,
"upload_time": "2023-07-18T11:39:04",
"upload_time_iso_8601": "2023-07-18T11:39:04.662023Z",
"url": "https://files.pythonhosted.org/packages/b9/67/0e3f230641e5d2908473605a70ee311e5da4c64337e19aace5468975b689/OTTAR-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-18 11:39:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MNiMORPH",
"github_project": "ottar",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "ottar"
}
JSON
