Coding Guidelines

Naming Conventions

Docker Container

Docker container names start with a prefix which describes the modality (e.g. mri, meg, eeg, ct, etc.) of the corresponding service/container. If a service is generic and independent of a certain modality, it is designated by the prefix "sh" for ScanHub. Database container have another tag "db" which follows the modality prefix.

The prefix section is followed by a meaningful and short container/service name. If a service/container controls other services, it is designated by a "manager" appendix.

In total there are four requirements: Modality tag, database tag if applicable, name and manager tag if applicable

<modality>-<db(optional)>-<name>-<manager(optional)>

Examples

MRI scanner control container: mri-<scan>-manager

ScanHub device controller: sh-<device>-manager

Database for MRI records: mri-db-<records>

A specific MRI reconstruction: mri-<cartesian-reco>

---