HOLMES

HOLMES (HydrOLogical Modeling Educational Software) is a software developed to teach operational hydrology. It is developed at Université Laval, Québec, Canada.

📖 Documentation · 📦 PyPI

Usage

Installation

pip install holmes-hydro

Running HOLMES

After installation, start the server with:

holmes

The web interface will be available at http://127.0.0.1:8000.

Configuration

Customize the server by creating a .env file:

DEBUG=True          # Enable debug mode (default: False)
RELOAD=True         # Enable auto-reload on code changes (default: False)
HOST=127.0.0.1      # Server host (default: 127.0.0.1)
PORT=8000           # Server port (default: 8000)

Development

Setup

1. Install uv:

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

2. Clone and install in development mode:

   git clone https://github.com/antoinelb/holmes.git
   cd holmes
   uv sync

Running

uv run holmes

Or activate the virtual environment and run directly:

source .venv/bin/activate
holmes

Code Quality

ruff format src/ tests/
ruff check src/ tests/
ty check src/ tests/

References

• Bucket Model