Skip to main content

A Python package for analytics in dam operations.

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 operations and water resources 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 help users prepare inputs for simulating water erosion and sediment transport, and support decision-making in dam network deployment for environmental sustainability.

Classes

The following classes are included in the package:

  • OptiDamTool.WatemSedem: Provides methods to prepare inputs for the WaTEM/SEDEM model, which predicts soil erosion, sediment transport capacity, and sediment delivery to stream networks at a watershed scale. While no methods have been implemented yet, development is currently underway.

  • OptiDamTool.Network: Offers methods for establishing network connectivity between dams based on stream networks and hydrological flow paths.

Features

The classes provide the following features:

Dam Network

  • Identification of 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
>>> 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.0.2.tar.gz (6.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.0.2-py3-none-any.whl (5.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: optidamtool-0.0.2.tar.gz
  • Upload date:
  • Size: 6.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.0.2.tar.gz
Algorithm Hash digest
SHA256 37840d07a4343c79891b72d5c269ce0caa32c28e516e8635ab9b743c0696ae9d
MD5 8048c209f656e9041556b0b0d41da877
BLAKE2b-256 cc3321a78079fc52cd5ada5b853553414b5c5073b30e5e4ed3f8d5a9532526d4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: optidamtool-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 5.9 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.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e88ae7fd4fb5a46c59826f43e3039343aae1d38aa8d0944a278800cd781ac0a8
MD5 6026b1f4966778401bb22693fa7ff40f
BLAKE2b-256 6a4ef9492e0e92d1d5d9fc70b8c1d9e6c8e710eb6353cdf7194a0c691cb00f70

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