Installation

tsim requires Python 3.10 or later.

Using uv (recommended)

We recommend using uv for dependency management.

uv add bloqade-tsim

For GPU acceleration with CUDA:

# For CUDA 13
uv add "bloqade-tsim[cuda13]"

# For CUDA 12
uv add "bloqade-tsim[cuda12]"

Using pip

pip install bloqade-tsim

For GPU acceleration with CUDA:

pip install "bloqade-tsim[cuda13]"

Development Setup

If you're contributing to tsim, clone the repository and install development dependencies:

git clone https://github.com/QuEraComputing/tsim.git
cd tsim
uv sync

Install pre-commit hooks to run linting checks automatically:

pre-commit install

This will run formatters and linters (black, isort, ruff, pyright) before each commit.