Overview

Overview#

For most users, the docs homepage and the Getting Started section are the best entry points into PyMedPhys.

A good reading order is:

  1. What PyMedPhys can do

  2. Choose your path

  3. Installation options

  4. Quick Start Guide

The Users Guide is organised into four main areas:

Getting Started

Start here if you’re new to PyMedPhys, unsure which interface to use, or need installation help.

How-to Guides

Task-focused guides for common workflows such as gamma and interpolation.

Technical Reference

Reference material for library modules and CLI commands. Use this when you already know the feature name and want precise inputs, outputs, and options.

Background

Explanations and context for larger projects and concepts.

If you want to contribute code or documentation, head to the Contributors Guide.