Skip to main content

Medical Physics library

Project description

logo

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.

streamlit build docs 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.

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.

Documentation

For App Users

Documentation of the PyMedPhys application’s graphical user interface doesn’t yet exist. Watch this space.

For Python Users

  • Absolute Beginners Tutorial [Doesn’t yet exist]

    • Start here if you are new to Python and would like an in-depth instruction on how to get started.

  • Quickstart How-To Guide

    • Start here if you are fluent in Python and just want a quick instruction on how to get started.

  • Tutorials

    • A range of lessons that take you through various complete projects with the intent to be able to show you what can be achieved with writing PyMedPhys based Python software yourself.

    • These are aimed at you if you don’t yet know what you can achieve with PyMedPhys but you would like to learn.

  • How-To Guides

    • Guides and recipes for common problems and tasks. These are aimed for you if you already know how to use Python and PyMedPhys and are looking for direction on a specific task you are trying to solve.

  • Reference

    • Technical reference for the library (modules, functions and classes), as well as the available command line tools. This is where you will find listed information for the exposed functionality of PyMedPhys.

    • This is aimed at you if you know exactly the feature you would like to use, you just want to see what inputs it requires and what outputs it gives.

  • Background

    • Explanation and discussion of key topics and concepts. This is aimed at you if you are looking to be able to think about PyMedPhys and its implementations at a higher level and understand more about them.

  • Glossary [Doesn’t yet exist]

    • List of the most important terms

For Contributors

  • Getting Started Contributing [Under construction]

    • Start here for learning how to contribute to PyMedPhys.

  • Developer Guide [Doesn’t yet exist]

  • Documentation Guide

    • How to contribute to this documentation.

  • Maintainers Guide [Doesn’t yet exist]

Our Team

PyMedPhys is what it is today due to its maintainers and contributors both past and present. Here is our team.

Maintainers

rccc sjs

Active contributors

uth uoc hgugm

Maintainer emeritus

rah

Past contributors

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pymedphys-0.35.0.tar.gz (986.0 kB view details)

Uploaded Source

Built Distribution

pymedphys-0.35.0-py3-none-any.whl (1.2 MB view details)

Uploaded Python 3

File details

Details for the file pymedphys-0.35.0.tar.gz.

File metadata

  • Download URL: pymedphys-0.35.0.tar.gz
  • Upload date:
  • Size: 986.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.8.5 Linux/5.4.0-56-generic

File hashes

Hashes for pymedphys-0.35.0.tar.gz
Algorithm Hash digest
SHA256 59a69e2fd7d0340065380e2ae31577d2315dddcb9cf0432464c22f9ed94f446c
MD5 0e52106aa648dd060c4ee4cb31ee15d1
BLAKE2b-256 142c65aba69ac3858799f1dd1420bf85189a02d12f1b1ee1b5a4cb95f01cf985

See more details on using hashes here.

File details

Details for the file pymedphys-0.35.0-py3-none-any.whl.

File metadata

  • Download URL: pymedphys-0.35.0-py3-none-any.whl
  • Upload date:
  • Size: 1.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.8.5 Linux/5.4.0-56-generic

File hashes

Hashes for pymedphys-0.35.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8d70081b350999faef01faf7757a59dcfcc344e57a9093c6c2dce6a3e016a5a4
MD5 1f1001056aba114c928d25d0200b0e53
BLAKE2b-256 62243b766e83a8eadf3567e227492c40b9b2450ed12569489bad95748127273f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page