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

pip install pipenv
pipenv install -e .
pipenv install -r examples/requirements.txt
pipenv install -r tests/requirements.txt
pipenv install -r docs/requirements.txt
pipenv install pre-commit
pre-commit install
git config core.autocrlf input

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

pipenv run jupyter lab

Branches

• The main development is done on the main branch
• Bugfixes for previous versions are done on separate fix-v0.0 branches