Documentation: https://mikevolk.github.io/QDMpy
Source Code: https://github.com/mikevolk/QDMpy
PyPI: https://pypi.org/project/QDMpy/
A python package for calculating magnetic maps from ODMR spectra measured on a quantum diamond microscope
pip install QDMpy- Clone this repository
- Requirements:
- Poetry
- Python 3.7+
- Create a virtual environment and install the dependencies
poetry install- Activate the virtual environment
poetry shellpytestThe documentation is automatically generated from the content of the docs directory and from the docstrings of the public signatures of the source code. The documentation is updated and published as a Github project page automatically as part each release.
Trigger the Draft release workflow (press Run workflow). This will update the changelog & version and create a GitHub release which is in Draft state.
Find the draft release from the GitHub releases and publish it. When a release is published, it'll trigger release workflow which creates PyPI release and deploys updated documentation.
Pre-commit hooks run all the auto-formatters (e.g. black, isort), linters (e.g. mypy, flake8), and other quality
checks to make sure the changeset is in good shape before a commit/push happens.
You can install the hooks with (runs for each commit):
pre-commit installOr if you want them to run only for each push:
pre-commit install -t pre-pushOr if you want e.g. want to run all checks manually for all files:
pre-commit run --all-filesThis project was generated using the wolt-python-package-cookiecutter template.