Release process

Building the package

1. Ensure Microsoft Visual C++ Build Tools are installed.

2. Install the required Python packages:

terminal

pip install -r requirements.txt

3. Build the package by running:

terminal

python setup.py build_ext
python setup.py sdist
python setup.py bdist_wheel

• sdist - creates a source distribution,

• bdist_wheel - builds a wheel distribution.

4. Install the package locally in editable mode for testing:

terminal

pip install -e .

Building the documentation

1. Build the documentation:

terminal

cd docs
make clean
make html

2. View the documentation by opening the following file in your browser:

docs/_build/html/index.html

Uploading to PyPI

1. Create a pull request to merge into the main branch:

• feature/branch_name –> develop

• develop –> main

2. Update the version number in setup.py:

setup(
    ...
    version="X.Y.Z",
)

3. Publish a new release on GitHub:

• Navigate to Releases > Draft a new release > Choose a tag > Create a new tag (vX.Y.Z) > Publish release

4. Verify that the build_deploy job is successful in the “Actions” tab.

If the job fails, debug the issue, delete the tag, and try again.

terminal

git push origin --delete vX.Y.Z