Getting started

Build the engine and run your first scenario.

The engine is a Rust workspace. The toolchain is pinned in rust-toolchain.toml, so a matching compiler is fetched automatically.

Build and test

git clone https://github.com/grid-modeller/grid-sim
cd grid-sim

cargo build --workspace          # toolchain pinned in rust-toolchain.toml
cargo test  --workspace --lib    # hermetic unit tests — no data needed

The --lib tests are hermetic and need no data. The full acceptance/regression suite additionally needs the data packs, which are fetched and built, never committed (see Reproducibility & data).

Run a scenario

Scenarios are TOML files under scenarios/ in the engine repo. The 2024 reference fleet — the one used for validation — is scenarios/gb-2024-reference.toml.

grid-cli run scenarios/gb-2024-reference.toml --out runs/2024-reference

Every output file carries a header embedding the determinism triple — the engine git hash, the scenario path and its SHA-256, and the created-UTC timestamp — plus a per-file SHA-256 for each data-pack file consumed. That header lets anyone confirm they ran exactly what you ran.

Note

This scaffold documents the public interface as it stands in the engine repo. Exact flag names and subcommands are authoritative in the engine’s own --help output and grid-cli/tests/cli.rs, not here.

Next

  • Reproduce the headline validation result step by step: Validation.
  • Browse curated precomputed runs without building anything: Run.