Getting StartedInstall Library

Install the B‑Simulant Library (Public)

This page covers installing the B‑Simulant Python library for local simulation workflows.

Requirements

  • Python 3.10+

Install

Install from your preferred Python environment:

pip install bsim

If you’re working from a checkout of the library repo (recommended for local development):

pip install -e .

Optional extras

Some features require optional dependencies (for example, certain adapters and the SimUI web interface). Install only what you need:

pip install "bsim[ui]"
pip install "bsim[adapters]"

Next steps