Skip to main content

Medical Physics library

Project description

logo

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.

build pypi python license

What is PyMedPhys?

PyMedPhys is an open-source Medical Physics python library built by an open community that values and prioritises 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 first paper in the Journal of Open Source Software contains more background information, including a 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

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.

Community

PyMedPhys has a Discourse community to both help you find your feet using PyMedPhys and to facilitate collaboration and general discussion. Please reach out over there and we’d love to get to know you!

Documentation

PyMedPhys can be installed with:

pip install pymedphys[user]

Further user installation instructions can be found in the Quick Start Guide.

The PyMedPhys documentation contains two overarching guides:

  1. The Users Guide: where you can find instructions to get started with the library and the CLI, in-depth how-to guides (examples for users) on PyMedPhys’ various tools, some background information on individual PyMedPhys projects as well as the Technical Reference.

  2. The Contributors Guide: for those who wish to make new contributions to the PyMedPhys library, CLI or app. Here you’ll find detailed workstation setup guides to enable contributions, important repository information, and some tips & tricks to overcome common issues.

Development

The PyMedPhys project is managed using Poetry.

After cloning the repository, install the PyMedPhys dependencies and set up pre-commit by running:

poetry install -E all
poetry run pre-commit install

Run automated tests with:

poetry run pymedphys dev tests

Our Team

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

Maintainers

sjs rah

Active contributors

uth ccr

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.41.0.tar.gz (7.0 MB view details)

Uploaded Source

Built Distribution

pymedphys-0.41.0-py3-none-any.whl (7.5 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pymedphys-0.41.0.tar.gz
  • Upload date:
  • Size: 7.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.11.4 Windows/10

File hashes

Hashes for pymedphys-0.41.0.tar.gz
Algorithm Hash digest
SHA256 0d17a0ae42a2c8a16b9970ba652176866f5655cc3c785d57d416cfeb8961ed63
MD5 e13bacc3609ed696b544204f7d01dc47
BLAKE2b-256 bcf059af199c9f966dd69f59cff77a802c0457f57aed39ebf93f6a99664f0448

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pymedphys-0.41.0-py3-none-any.whl
  • Upload date:
  • Size: 7.5 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.11.4 Windows/10

File hashes

Hashes for pymedphys-0.41.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9fd7ff9f60c8875ff207e2bf59e78bec4739008ed17a2c5f31ffeaf51e945463
MD5 3fea8d7fc8ca3e0d103492a9783737e9
BLAKE2b-256 ce378681eec106cebc8cae3964fa647637ed3a29f427d03e7aa2db61a8248518

See more details on using hashes here.

Supported by

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