Setup

Setting up a development environment

Prerequisites: Up-to-date python installation with pip

Clone the repository

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

Setting up a virtual environment and install additional dependencies for development

virtualenv .venv
source .venv/bin/activate
pip install -r requirements/docs-requirements.txt # optional, to build documentation locally (only for the python version listed in `requirements/.python-version` file)
pip install -r requirements/tests-requirements-py3.12.txt # adjust this to your python version
pip install -e .
pip install pre-commit
pre-commit install
git config core.autocrlf input

Launch a Jupyter session for testing and debugging of the example notebooks

source .venv/bin/activate
jupyter lab