Skip to content

Getting Started

Follow these steps to set up Ascribe with CIRVA models locally and run a minimal example.

Prerequisites

  • Python 3.13+ (verify: python3 --version)
  • uv (Python packaging tool)

Install uv (macOS/Linux):

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

Or via pipx:

pipx install uv

Clone and install

git clone https://github.com/aridyckovsky/ascribe.git
cd ascribe
uv sync

Quick start

Run a small demo (see scripts/ for more examples):

uv run python scripts/run_small_sim.py

Develop/docs locally

Build docs (strict):

bash tools/generate_docs.sh
open site/index.html

Next steps

Read the Core contracts and grammar

Explore module guides

Key Dependencies