Development#

New contributors can start with Contributing and Development environment. For an existing checkout, use Testing and Code quality to check a change, Building and editing the docs to update the manual, or Performance benchmarking to investigate performance. Release maintainers can go directly to Release process.

Find your way around the repository#

Source layout#

Location

Purpose

zrad/image.py and zrad/io/

Image representation and DICOM/NIfTI input and output.

zrad/preprocessing/, zrad/filtering/, zrad/radiomics/

Processing steps, filters, and feature extraction.

zrad/batch/

Workflows that process case folders and write results.

main.py, zrad/gui/, and zrad/visualization/

Desktop application, controls, and image viewer.

tests/

Unit and integration tests, reference data, and performance benchmarks.

docs/

Narrative guides, API reference pages, and Sphinx configuration.

.github/workflows/

Automated checks, documentation deployment, and release jobs.