Developer guide

Developer guide#

Repository development, contribution and release procedures.

Page

Scope

Development prerequisites

Git, Python and the C and C++ toolchain.

Editable installation

Editable installation and development dependencies.

Development workflow

Fork-based development, branches and pull requests.

Coding style

Ruff, formatting, tests, the KomaMRI simulation, C89 and code conventions.

Documentation

Documentation types and scientific writing.

Terminology and conventions

Scanner, protocol, Pulseq and MRD terminology, units and layers.

Internals

The implementation behind the explanations: the IR cache, the protocol text blocks, the reconstruction proxy and the virtual scanner.

Pre-commit

Local hooks, deliberate bypasses and CI.

Pull requests

Pull-request contents and validation.

Releases

Versioning, wheels, PyPI and the published documentation.

Code of conduct

Project participation policy.