Overview

A community effort to develop an open standard library for Medical Physics in Python. Building quality transparent software together via peer review and open source distribution. Open code is better science.

build pypi python license

What is PyMedPhys?

An open-source Medical Physics python library with a focus on being a place to share, review, improve, and transparently learn off of each other’s code. It is inspired by the collaborative work of our physics peers in astronomy and their Astropy Project. PyMedPhys is available on PyPI and GitHub.

Mailing list

If you would like to dive into the community a great place to get started is to sign up to the mailing list and say hi by introducing yourself with where you’re from, and what you hope to achieve with PyMedPhys.

Table of contents

Tutorials

Get started with a hands-on introduction to PyMedPhys for beginners

How-To guides

Guides and recipes for common problems and tasks

Reference

Technical reference for the library (modules, functions and classes), as well as the available command line tools.

Background

Explanation and discussion of key topics and concepts

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. In fact, it is very likely that the entire API will change multiple times before a 1.0.0 release. In practice, this means that upgrading pymedphys to a new version will possibly break any code that was using the old version of pymedphys. We try to be abreast of this by providing details of any breaking changes from one release to the next within the Release Notes.

Our Team

PyMedPhys is what it is today due to its contributors. Core contributors and contributors who have been active in the last six months as well as their respective employers are presented below.