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.

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.

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.0.tar.gz (8.2 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.0-py3-none-any.whl (7.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: optidamtool-0.1.0.tar.gz
  • Upload date:
  • Size: 8.2 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.0.tar.gz
Algorithm Hash digest
SHA256 61d200a1a63149e7f5cc66f0416f79ff7c6352d46c5b9061fb62e9ab4c12b0ce
MD5 2d93b1bf4ea10d3c7704a500c2eeb7df
BLAKE2b-256 186e180630646134b6228a1e7b37e933d1ed9fb8a950b3cf55eaaddabaf66c49

See more details on using hashes here.

File details

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

File metadata

  • Download URL: optidamtool-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.6 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3af2c5a2786d0ee66ec346c6e91c908a8c46c6e47286a22fe4759dcd369191d6
MD5 e28c42791e96b9f95b737c2008f52000
BLAKE2b-256 013cd63fc6ae30e10121bb2aacf5c1fe5fdd4142391a8b30e8deb1c632ef965a

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