Getting started

Installation

The core package is distributed on PyPI as equilibrium-labs and imports as equilibrium. It supports Python 3.10 and later.

Installing the package

A plain install gets you claimcheck, the synthetic data generators, the source registry client, and the equilibrium CLI. The mcp extra additionally installs the dependencies needed to run the Equilibrium MCP server locally or self-hosted.

# Core package: claimcheck, generators, registry client, CLI
pip install equilibrium-labs

# With MCP server support
pip install "equilibrium-labs[mcp]"

# Pinned to a specific release, inside a virtual environment
python -m venv .venv
source .venv/bin/activate
pip install "equilibrium-labs==<version>"

We recommend installing inside a virtual environment or a project-managed environment (uv, poetry, conda) rather than into a system Python, both for isolation and so that the environment lockfile referenced in provenance manifests stays meaningful.

Verifying the install

Run the following to confirm the package imported correctly and to check which version you’re on — useful when filing an issue or comparing behavior against the changelog.

import equilibrium

print(equilibrium.__version__)
# prints the installed version

If you installed the mcp extra, equilibrium.mcp should also import without error:

import equilibrium.mcp

print(equilibrium.mcp.__version__)

Next steps

Continue to the quickstart to validate your first claim and generate a small synthetic sample.