Developer Documentation

This repository’s developer documentation is split into focused pages under docs/developer/.

Developer documentation

Use the pages below for setup, development, and maintenance tasks.

• Installation (per-machine)
• Setup (per-repo)
• Development (contributor workflow)
• Testing (test & CI)
• Maintenance (updates & tooling)
• Monorepo / uv workspaces
• Data publication audit
• Gurobi license management
• Publish on GitHub

Quick start

Minimal commands that get a developer from zero to a working repository on a machine (full commands shown for PowerShell (pwsh) and bash). These are the explicit, copyable commands we recommend to run in order.

Prerequisites for Quick Start

Run these commands to verify required tools are available on your machine. All commands are valid in PowerShell (pwsh) and POSIX shells (bash).

Terminal (pwsh / bash):

# Check Git -> if fails, install Git
git --version
# Check UV -> if fails, see Installation section
uv --version
# Check pre-commit -> if fails, see Installation section
pre-commit --version

Quick Start Setup

Run these commands to get a working environment and hooks.

Terminal (pwsh / bash):

# 1. For a clean setup: Clone the GitLab repository
git clone git@gitlab.uclv.net:energy-research-centre/frameworks/open-ev-fleet.git
# 2. Change into the repository folder
cd open-ev-fleet
# 3. Create and sync python environment
uv sync --all-groups --all-extras
# 4. Install pre-commit hooks
pre-commit install
# 5. Run pre-commit hook to verify setup
pre-commit run --all-files
# 6. Run pre-push hook to verify setup
pre-commit run --all-files --hook-stage pre-push

For detailed instructions, pick the relevant page above.

Try it (developer)

A minimal example script is available at packages/openevfleet/scripts/template/run_algorithm.py.

Terminal (pwsh / bash):

# From the repository root, with a uv-synced environment active
python packages/openevfleet/scripts/template/run_algorithm.py