Repository structure

Branch Structure

The default and working branch of the repository is develop. Other feature branches may contain code and tests that have been contributed but not yet completed, re-structured and approved by the taskforce.

Folder Structure

Contributed source code

Source code contributions are organised by contributor and institution: src/original/<contribution>, e.g. src/original/ST_SydneyAus
Each folder may include more than one type of functionality. In general, this code is provided in its original form, i.e. it has not been modified by the taskforce. Some limited changes may be required to permit testing, however.

Tests

Unlike the source code, tests developed by the taskforce are organised according to the type of functionality: /test/<functionality>, e.g. /test/T1_mapping/
Within each folder, a test file will be created for each code contribution that includes the type of functionality, e.g.
test/T1_mapping/test_t1_ST_SydneyAus.py
test/T1_mapping/test_t1_MJT_EdinburghUK.py

Information

Information about the code and the repository is available in:

• Wiki: documentation and guides
• doc/code_contributions_record.csv: record of code contributions and tests
• Issues: issues raised, calls for code contributions and other developments to the repository
• Automated test results. Click on a workflow run, "show all jobs", select a build, then "Test with pytest"