Skip to main content

A Python package for analytics in dam management workflows.

Project description

OptiDamTool

Status Description
PyPI PyPI - Version PyPI - Status PyPI - Python Version PyPI - Wheel
GitHub GitHub commit activity GitHub last commit flake8 mypy pytest
Codecov codecov
Read the Docs Read the Docs
PePy Pepy Total Downloads
License GitHub License

OptiDamTool is a Python package designed for analytics and decision-making in dam management. Conceptualized and released on May 29, 2025, the package offers tools for modeling and analyzing hydrological flow across a network of connected dams.

Leveraging functionalities from the open-source GeoAnalyze package, OptiDamTool provides classes that that assist users in preparing inputs for simulating water erosion and sediment transport, and supports decision-making in dam network deployment aimed at environmental sustainability.

Classes

OptiDamTool.WatemSedem

Provides methods to prepare inputs for simulating the WaTEM/SEDEM model, which predicts soil erosion, sediment transport capacity, and sediment delivery to stream networks at the watershed scale. This class currently provides the following feature:

  • Converts Digital Elevation Model (DEM) data into the stream files required for the WaTEM/SEDEM model, with the river routing = 1 extension enabled.
  • Generates effective upstream drainage polygons for selected dam locations within a stream network.

OptiDamTool.Network

Offers methods for establishing hydrological and sedimentation flow connectivity between dams using the stream network. This class currently provides the following feature:

  • Identifies connectivity between adjacent upstream and downstream dams.
  • Computes the effective upstream drainage area values for selected dam locations within a stream network.

Easy Installation

To install, use pip:

pip install OptiDamTool

Quickstart

A brief example of how to start:

>>> import OptiDamTool
>>> watemsedem = OptiDamTool.WatemSedem()
>>> network = OptiDamTool.Network()

Documentation

For detailed information, see the documentation.

Support

If this project has been helpful and you'd like to contribute to its development, consider sponsoring with a coffee! Support will help maintain, improve, and expand this open-source project, ensuring continued valuable tools for the community.

Buy Me a Coffee

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

optidamtool-0.1.1.tar.gz (9.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

optidamtool-0.1.1-py3-none-any.whl (9.2 kB view details)

Uploaded Python 3

File details

Details for the file optidamtool-0.1.1.tar.gz.

File metadata

  • Download URL: optidamtool-0.1.1.tar.gz
  • Upload date:
  • Size: 9.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.7

File hashes

Hashes for optidamtool-0.1.1.tar.gz
Algorithm Hash digest
SHA256 47209665911994a59e0bf2158b75f325f631ec26d48060f23fcce2b6c1b0b603
MD5 f676c6873fd9f2ac1064b1766a1b434b
BLAKE2b-256 9dc552c606089439557ae33eabcf9ad2d8dcc08cfc2d967ce4bd960b4ee4cbac

See more details on using hashes here.

File details

Details for the file optidamtool-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: optidamtool-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 9.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.7

File hashes

Hashes for optidamtool-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f2f97c59bcb7169dfab4ef64d7826473801734ddef7a517131495f49ced65f30
MD5 67e56ee5f4172056eb1ab2aab697015c
BLAKE2b-256 eeced3b278b24067ff6fae50fd204fc021953bb0feed069cf4d8a172b2ddd11f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page