ottar

Ode To Transient Ancho de los Rivers: Transient evolution of river-channel width in response to river discharge and bank and sediment properties.

https://github.com/mnimorph/ottar

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (8.5%) to scientific vocabulary

Keywords

floods geomorphology rivers
Last synced: 6 months ago · JSON representation ·

Repository

Ode To Transient Ancho de los Rivers: Transient evolution of river-channel width in response to river discharge and bank and sediment properties.

Basic Info
  • Host: GitHub
  • Owner: MNiMORPH
  • License: gpl-3.0
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 965 KB
Statistics
  • Stars: 6
  • Watchers: 2
  • Forks: 5
  • Open Issues: 0
  • Releases: 7
Topics
floods geomorphology rivers
Created almost 6 years ago · Last pushed 11 months ago
Metadata Files
Readme License Citation

README.md

DOI

: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!

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−3 | | 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 & Mller (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−7 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. $\taub = (1+\epsilon) \tau\beta$, where $\taub$ 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−3–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−4–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).

Owner

  • Name: MNiMORPH
  • Login: MNiMORPH
  • Kind: organization
  • Location: Minneapolis, MN, USA

Minnesotans Mulling over Rivers, Particles, and Hillslopes (UMN and MSU Mankato geomorph groups)

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Wickert"
  given-names: "Andrew D."
  orcid: "https://orcid.org/0000-0002-9545-3365"
title: "OTTAR"
version: 0.7.0
doi: 10.5281/zenodo.5124965
date-released: 2025-03-29
url: "https://github.com/MNiMORPH/OTTAR"

GitHub Events

Total
  • Watch event: 1
  • Push event: 6
Last Year
  • Watch event: 1
  • Push event: 6

Committers

Last synced: about 2 years ago

All Time
  • Total Commits: 207
  • Total Committers: 2
  • Avg Commits per committer: 103.5
  • Development Distribution Score (DDS): 0.005
Past Year
  • Commits: 73
  • Committers: 1
  • Avg Commits per committer: 73.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Andy Wickert a****y@n****m 206
hgudipati h****i@g****m 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 0
  • Total pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: less than a minute
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
  • awickert (3)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 47 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 5
  • Total maintainers: 1
pypi.org: ottar

Ode To Transient Ancho de los Rivers: Transient evolution of river-channel width

  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 47 Last month
Rankings
Dependent packages count: 7.4%
Forks count: 14.3%
Average: 20.9%
Dependent repos count: 22.3%
Stargazers count: 23.2%
Downloads: 37.4%
Maintainers (1)
Last synced: 6 months ago

Dependencies

setup.py pypi
  • matplotlib *
  • numpy *
  • pandas *
  • scipy *