Library for Brillouin microscopy data analysis
Project description
This is a Python library for the post-measurement analysis of Brillouin microscopy data.
Documentation
The documentation, including the code reference and examples, is available at bmlab.readthedocs.io.
Installation
pip install bmlab[all]
For more options, please check out the documentation.
Information for developers
Contributing
The main branch for developing bmlab is main. If you want to make small changes like one-liners, documentation, or default values in the configuration, you may work on the main branch. If you want to change more, please (fork bmlab and) create a separate branch, e.g. my_new_feature_dev, and create a pull-request once you are done making your changes. Please make sure to edit the Changelog.
Very important: Please always try to use
git pull --rebase
instead of
git pull
to prevent confusions in the commit history.
Tests
bmlab is tested using pytest. If you have the time, please write test methods for your code and put them in the tests directory.
Incrementing version
bmlab currently gets its version from the latest git tag. If you think that a new version should be published, create a tag on the main branch (if you have the necessary permissions to do so):
git tag -a "0.1.3" git push --tags origin
CI jobs will then automatically build source package and wheels and publish them on PyPI.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
