💧 Water Forecast AI

Water Forecast AI is a project under development focused on data analysis and water consumption forecasting using Artificial Intelligence models.

🚀 Features

• Time series forecasting with models such as LSTM, ARIMA, and Prophet.
• Exploratory Data Analysis (EDA) and signal preprocessing.
• Evaluation metrics including MAE, RMSE, and R².
• Modular structure for reproducible ML pipelines and experiments.
• Type-safe Python code with mypy support.
• Code formatting and linting with ruff.
• Automated testing with pytest and coverage reporting.
• Environment and tooling management via uv and pyproject.toml.

⚙️ Environment Setup

This project uses uv for Python environment and dependency management.

Install uv

curl -LsSf https://astral.sh/uv/install.sh | sh

Create and activate virtual environment

uv venv .venv
source .venv/bin/activate

Install development dependencies

uv pip install -e ".[dev]"

🔒 Dependency Locking

To generate a lockfile for reproducible environments:

pip-compile pyproject.toml --extra=dev --output-file=requirements.lock.txt

This ensures all dependencies (including transitive ones) are pinned and can be synced across environments with full reproducibility.

🧪 Running Tests

After activating the virtual environment:

pytest

With coverage report:

pytest --cov=water_forecast_ai --cov-report=term-missing

🧹 Code Quality Checks

Run Ruff (linter & formatter)

ruff check water_forecast_ai

Run Mypy (type checker)

mypy water_forecast_ai

---