======================
Overview
======================

For most users, the docs homepage and the
:doc:`Getting Started section <users/get-started/index>` are the best entry
points into PyMedPhys.

A good reading order is:

#. :doc:`What PyMedPhys can do <users/get-started/what-pymedphys-can-do>`
#. :doc:`Choose your path <users/get-started/choose-your-path>`
#. :doc:`Installation options <users/get-started/installation-options>`
#. :doc:`Quick Start Guide <users/get-started/quick-start>`

The **Users Guide** is organised into four main areas:

:doc:`Getting Started <users/get-started/index>`
    Start here if you're new to PyMedPhys, unsure which interface to use, or
    need installation help.

:doc:`How-to Guides <users/howto/index>`
    Task-focused guides for common workflows such as gamma and interpolation.

:doc:`Technical Reference <users/ref/index>`
    Reference material for library modules and CLI commands. Use this when you
    already know the feature name and want precise inputs, outputs, and options.

:doc:`Background <users/background/index>`
    Explanations and context for larger projects and concepts.

If you want to contribute code or documentation, head to the
:doc:`Contributors Guide <contrib/index>`.