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

Development is done on the main branch directly for small changes, and vie separate feature branches and merge request for larger changes.