waterworksai 3.0.0

Official Python client for waterworks.ai API

waterworksai

Official Python client for the waterworks.ai API, providing seamless access to:

• Inflow & Infiltration decomposition
• Water component analysis
• 48-hour flow forecasting
• Leakage & sewer blockage detection
• Pipe survival & remaining useful life (RUL) estimation

---

Installation

pip install waterworksai

Quick Start

import pandas as pd
from waterworksai import WaterworksClient
from waterworksai.adapters import from_dataframe
from waterworksai.tasks.forecast import Forecast48h

# Load your hourly flow CSV
df = pd.read_csv("hourly_flow.csv")
df["Date"] = pd.to_datetime(df["Date"])

# Convert to canonical TimeSeriesPoint
points = from_dataframe(df, time_col="Date", value_col="Volume")

# Initialize API client
client = WaterworksClient(api_key="YOUR_API_KEY")

# Run 48-hour forecast
result = client.post(
    "forecast",
    Forecast48h(df=points).payload()
)

print("Forecast MAE:", result["MAE"])
print("Forecast points:", result["forecast"])

Examples

Examples

Full working examples for all tasks are available in the examples/ folder:

• forecast_48h.py

• inflow_infiltration.py

• leakage.py

• pipe_survival.py

These scripts demonstrate DataFrame integration, API calls, and result handling.

License

MIT © waterworks.ai