Setup

Setting up a development environment

Prerequisites: Install git and uv.

Clone the repository:

git clone git@github.com:xsuite/xplt.git
cd xplt

Create the virtual environment and install dependencies:

# Minimal setup
uv sync --group dev

# Complete setup to be able to run example notebooks, tests and build the docs:
uv sync --all-groups --all-extras

Install the Git hooks:

uv run prek install

Launching Jupyter Notebooks

Launch Jupyter Lab for testing and debugging the example notebooks:

uv run jupyter lab

The example notebooks are also part of the project's test/documentation workflow. If you add or modify an example, make sure that it can be executed successfully with the supported dependencies.

Running tests

See Testing

Building the documentation locally

uv run sphinx-build docs _build/html
uv run -m http.server --directory _build/html