Skip to main content

A Python package for estimating environmental flow requirements using hydrological methods.

Project description

eflowpy

eflowpy is a Python package for estimating environmental flow requirements using hydrological methods based on streamflow time series data. It provides a consistent and extensible interface for calculating commonly used flow-based environmental indicators.

Features

  • Calculate environmental flow recommendations using:
    • Tennant Method
    • Flow Duration Curve (FDC)
    • GEFC (Generalized Environmental Flow Criteria)
    • 7Q10 Method
    • Tessman Method
  • Built-in plotting support:
    • Time series plots
    • Flow threshold overlays

Installation

To install eflowpy from PyPI:

pip install eflowpy

How to Use

Quick Start Example

import pandas as pd
from eflowpy.hydrological.tennant import Tennant
from eflowpy.utils.data_reader import read_streamflow_data

# Load streamflow time series from file
flow_series = read_streamflow_data("gauge_12013059_daily.csv", folder="path/to/your/data")

# Run Tennant method
tennant = Tennant(flow_series)
tennant.print_summary()
result = tennant.calculate()
print(result)

# Plot bar chart and streamflow overlay
tennant.plot()
tennant.plot_with_levels()

License

This project is licensed under the MIT License.

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

eflowpy-1.0.0.tar.gz (8.7 kB view details)

Uploaded Source

Built Distribution

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

eflowpy-1.0.0-py3-none-any.whl (11.6 kB view details)

Uploaded Python 3

File details

Details for the file eflowpy-1.0.0.tar.gz.

File metadata

  • Download URL: eflowpy-1.0.0.tar.gz
  • Upload date:
  • Size: 8.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for eflowpy-1.0.0.tar.gz
Algorithm Hash digest
SHA256 6f87a0863dd4eee512851d49d4f41e8538ba18ac272ab6b6ed97339aea506371
MD5 7a596659ed74f19ec4d7c9c3142f66ed
BLAKE2b-256 0ad3245ff83fe2f71e17c8d0faab40ec00a83b960b04c51c1f1d95e45ae15574

See more details on using hashes here.

File details

Details for the file eflowpy-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: eflowpy-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 11.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for eflowpy-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e0a8c8c080d88155abe5cbd711da1cb838ab701dc4699d5fa0263022acea8654
MD5 89cb0948f3666c84bd08b66ad748a031
BLAKE2b-256 480c0dba32d3314033e7a625427b22690eb4874889d20fa5fed8cf8020d0502a

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