Getting Started

Start here if you are new to PyMedPhys, new to Python in a clinical workflow, or unsure whether you should use the library, the CLI, or the app layer.

For most users, the best reading order is:

1. What PyMedPhys can do

2. Choose your path

3. Installation options

4. Quick Start Guide

If you already know that you want shell or scheduled-job automation, also read Using the CLI after installation.

• What PyMedPhys can do
  • If you want to compare dose or fluence-like data
  • If you want to work with DICOM
  • If you want to work with delivery or machine log data
  • If you want to query or integrate with Mosaiq
  • If you want point-and-click tools
  • If you want electron cutout factor tools
  • There is more than this
  • Where to go next
• Choose your path
  • Fast decision
  • Side-by-side comparison
  • Common scenarios
  • Practical recommendations
  • Where to go next
• Installation options
  • Recommended approach
  • Why there is more than one install
  • Important note about the commands on this page
  • User-facing extras
  • Recommended combinations
  • What most users should choose
  • A note on all
  • Next step
• Quick Start Guide
  • Install uv
  • Create a Python environment
  • Install PyMedPhys
  • Use the environment
  • Troubleshooting installation
  • Fallback if you cannot use uv
  • Next steps
• Using the CLI