This release is a pre-release and may not be stable for production use.
A community effort to develop an open standard library for Medical Physics in Python. We build high quality, transparent software together via peer review and open source distribution. Open code is better science.
What is PyMedPhys?
PyMedPhys is an open-source Medical Physics Python library built by an open community that values code sharing, review, improvement, and learning from each other. It is inspired by the collaborative work of our physics peers in astronomy and the Astropy Project. PyMedPhys is available on PyPI and GitHub.
PyMedPhys supports three main ways of working:
a Python library for notebooks, scripts, and clinic-specific tooling
a command line interface (CLI) for repeatable automation
a point-and-click app layer for selected workflows
Beta level of development
PyMedPhys is currently within the beta stage of its life-cycle. It will stay in this stage until the version number leaves 0.x.x and enters 1.x.x. While PyMedPhys is in beta stage, no API is guaranteed to be stable from one release to the next. Upgrading pymedphys can therefore break existing scripts or workflows. We try to stay ahead of that by documenting breaking changes in the Release Notes.
Start here
If you are new to PyMedPhys, start with these four questions in order:
Common task areas
PyMedPhys is often used to:
compare dose or fluence-like data with gamma, interpolation, and MetersetMap
work with DICOM and pseudonymisation workflows
work with delivery, logfile, and iCom data
query or integrate with Mosaiq
use point-and-click apps for selected workflows
Install PyMedPhys
PyMedPhys currently supports Python 3.10, 3.11, and 3.12.
For most users, we recommend using uv to create an environment and install PyMedPhys:
uv python install 3.12
uv venv --python 3.12
uv pip install "pymedphys[user]"If you cannot use uv on your workstation, the Quick Start Guide also includes a standard Python + venv + pip fallback path.
Choose the right interface
Use the Python library when you want notebooks, analysis, plots, and clinic-specific workflows.
Use the CLI when you want repeatable commands, scheduled jobs, or shell automation.
Use the app layer when you want the least coding and a graphical workflow.
For a fuller comparison, read Choose your path.
Documentation
The PyMedPhys documentation has two overarching guides:
The Users Guide: where you can get started with the library, the CLI, and the app layer; read task-focused how-to guides; find background information on larger projects and concepts; and browse the Technical Reference when you already know the feature you need.
The Contributors Guide: for those who want to contribute to PyMedPhys. This includes the Contributors Guide landing page, detailed workstation setup guides, important repository information, and some tips & tricks for common problems.
Community
PyMedPhys has a GitHub Discussions page to help users find their feet and to support collaboration and general discussion.
Citing PyMedPhys
PyMedPhys’ first paper in the Journal of Open Source Software contains more background information, including the Statement of Need. You can access the paper here.
When referencing PyMedPhys, please cite this paper as follows:
Biggs, S., Jennings, M., Swerdloff, S., Chlap, P., Lane, D., Rembish, J., McAloney, J., King, P., Ayala, R., Guan, F., Lambri, N., Crewson, C., Sobolewski, M. (2022). PyMedPhys: A community effort to develop an open, Python-based standard library for medical physics applications. Journal of Open Source Software, 7(78), 4555, https://doi.org/10.21105/joss.04555
Development
PyMedPhys uses uv for package and project management and Hatchling to build distributions. See the Contributors Guide for the complete setup and PR workflow.
After cloning the repository, install the PyMedPhys dependencies and set up pre-commit by running:
uv sync --python 3.12 --locked --extra all --group dev
uv run -- pre-commit installRun automated tests with:
uv run -- pymedphys dev testsOur Team
PyMedPhys is what it is today due to its maintainers and contributors, both past and present. Here is our team.
Maintainers
- Stuart Swerdloff
SJS Targeted Solutions, LLP, New Zealand
- Matthew Jennings
Icon Group, Australia
- Phillip Chlap
Radformation Inc., USA
University of New South Wales, Australia
Active contributors
- Derek Lane
ELEKTA AB, Houston TX
- Marcelo Jordao
ELEKTA AB, Hong Kong SAR
- Marcus Fisk
Cancer Care Riverina, Australia
Past contributors
4 maintainers
Release files for pymedphys 0.42.0.dev0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pymedphys-0.42.0.dev0.tar.gz | 2.0 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pymedphys-0.42.0.dev0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 4.3 MB
Release files / pymedphys-0.42.0.dev0.tar.gz
| Download URL | pymedphys-0.42.0.dev0.tar.gz |
|---|---|
| Size | 2.0 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
481b234ab14d0aa7b1af0e5595aae1f1afd9e414735e316ffe6eb3aaafdc1391
|
|
BLAKE2b-256 checksum How to use checksums |
d43188318b2440e2b4a8da7199c5378ab11e2eafd2fcbfa72e7f764dd8335ff5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 25, 2026.
Transparency logRelease files / pymedphys-0.42.0.dev0-py3-none-any.whl
| Download URL | pymedphys-0.42.0.dev0-py3-none-any.whl |
|---|---|
| Size | 2.3 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c74f158ccd029a8171f552cc1cd54d23fdc79a6093992aa1c6bf870299d469a0
|
|
BLAKE2b-256 checksum How to use checksums |
21609902e31563e1174cb4816ffda850740e9c3e1d81eeba095949e38de4da79
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 25, 2026.
Transparency log
