A graphical user interface for controlling and monitoring an interferometer device.
Technical documentation is available on FINESSE's GitHub Pages site.
This is a Python application that uses poetry for packaging and dependency management. It also provides pre-commit hooks for various linters and formatters and automated tests using pytest and GitHub Actions. Pre-commit hooks are automatically kept updated with a dedicated GitHub Action.
To get started:
Download and install Poetry following the instructions for your OS.
Clone this repository and make it your working directory
Set up the virtual environment:
poetry install
Activate the virtual environment (alternatively, ensure any python-related command is preceded by poetry run
):
poetry shell
Install the git hooks:
pre-commit install
Run the main app:
python -m finesse
Run the tests:
pytest
Build the user guide:
Install pandoc
python docs/gen_user_guide.py