:notoc:

************************
pyRadPlan documentation
************************

**Date**: |today| **Version**: |version|
pyRadPlan is an open-source, multi-modality radiotherapy treatment planning toolkit designed for interoperability with `matRad <http://www.matRad.org>`_.
pyRadPlan is born from the established Matlab-based toolkit `matRad <http://www.matRad.org>`_. As such, pyRadPlan aims to provide a framework as well as tools for combining dose calculation with optimization with focus on ion planning.

Development is lead by the `Radiotherapy Optimization group <https://www.dkfz.de/radopt>`_ at the `German Cancer Research Center (DKFZ) <https://www.dkfz.de>`_


.. grid:: 1 2 2 2
    :gutter: 4
    :padding: 2 2 0 0
    :class-container: sd-text-center



    .. grid-item-card:: Installation
        :class-card: intro-card
        :shadow: md

        +++

        .. button-ref:: installation
            :ref-type: ref
            :click-parent:
            :color: secondary
            :expand:

            To the installation guide

    .. grid-item-card:: User guide
        :class-card: intro-card
        :shadow: md

        +++

        .. button-ref:: user_guide
            :ref-type: ref
            :click-parent:
            :color: secondary
            :expand:

            To the user guides



    .. grid-item-card:: Api
        :class-card: intro-card
        :shadow: md

        +++

        .. button-ref:: api_documentation
            :ref-type: ref
            :click-parent:
            :color: secondary
            :expand:

            To the api documentation


    .. grid-item-card:: Help and support
        :class-card: intro-card
        :shadow: md

        +++

        .. button-ref:: help
            :ref-type: ref
            :click-parent:
            :color: secondary
            :expand:

            To the help and support

.. toctree::
      :maxdepth: 1
      :hidden:
      :titlesonly:

      api/index
      installation/index
      user_guide/index
      help/help