Repository Features

Directory structure

• .github.workflows: Contains our github action runners
  • bump_version.yaml: Bumps the package version number for every push to main with src changes
  • license_check.yaml: Checks validity of licenses of packages used in repo
  • package.yaml: Builds a conda package out of the repo
  • pytest_mypy.yaml: Runs pytests, ruff checks, and mypy checks
  • release.yaml: Builds and release a conda packageon version bump
  • update_documentation: Updates the central virdocs when pushed to main
• config: Hydra config.yaml files for scripts
  • evaluation: config file for evaluation of registration framework
  • training: config files for training, see section Training for more information
• docs: Mkdocs documentation files
• scripts: Executable python scripts
• src: Main source code
• tests: all tests

Docs

We use mkdocs and host the documentations on our server. For full documentation visit mkdocs.org.

The repo for the documentation can be found here: GitHub virdocs The documentation itself can be found here: virdocs

The central documentation is automatically updated upon a push to main (a Github action runner takes care of this). To locally test the documentation run:

mkdocs serve

Precommit

Installed pre-commit hooks are:

• ruff (linter)