Developer guide#
Repository development, contribution and release procedures.
Page |
Scope |
|---|---|
Git, Python and the C and C++ toolchain. |
|
Editable installation and development dependencies. |
|
Fork-based development, branches and pull requests. |
|
Ruff, formatting, tests, the KomaMRI simulation, C89 and code conventions. |
|
Documentation types and scientific writing. |
|
Scanner, protocol, Pulseq and MRD terminology, units and layers. |
|
The implementation behind the explanations: the IR cache, the protocol text blocks, the reconstruction proxy and the virtual scanner. |
|
Local hooks, deliberate bypasses and CI. |
|
Pull-request contents and validation. |
|
Versioning, wheels, PyPI and the published documentation. |
|
Project participation policy. |