Installation of the project on your device¶

Set up your Integrated Development Environment (IDE)

Before you can get started you have to install an IDE such as VSCode or PyCharm on your device. Since most of the setup instructions are for VSCode, this IDE is recommended if you are new to programming.

Install Python

Install a Python Version (\(\ge\) 3.10) that works with the dependencies of the project. To install Python 3.12 download and run the installer from the Python website.

Installation¶

Easy way¶

To install the latest release of the project via PyPI, open a command prompt and type pip install bsm2-python

Build from source¶

If you want the bleeding edge version from the repo, build it yourself via the prompt hatch build. See the Contribution Guide for more details on how to install hatch (or simply use the Docker image). Then you can install it to arbitrary environments via
pip install dist/bsm2_python<version-hash>.whl.