.. include:: includes/logo.rst

.. |icon_about| image:: images/aboutIconThick2(klein).png
    :target: `about`

.. |icon_setup| image:: images/setupIcon(klein).png

.. |icon_techdoc| image:: images/technicalDocumentationIcon(klein).png
    :target: `techdoc`

.. _Home:

====
Home
====

.. image:: https://img.shields.io/github/v/release/e0404/matRad
   :target: https://github.com/e0404/matRad/releases
   :alt: Current Release

.. image:: https://img.shields.io/github/downloads/e0404/matRad/total
   :target: https://github.com/e0404/matRad/releases
   :alt: Downloads

.. image:: https://img.shields.io/github/contributors/e0404/matRad
   :target: https://github.com/e0404/matRad/graphs/contributors
   :alt: Contributors

.. image:: https://img.shields.io/endpoint?url=https%3A%2F%2Fapi.juleskreuer.eu%2Fcitation-badge.php%3Fshield%26doi%3D10.1002%2Fmp.12251&style=flat&color=blue
   :alt: Citations

.. image:: https://github.com/e0404/matRad/actions/workflows/tests.yml/badge.svg
   :target: https://github.com/e0404/matRad/actions/workflows/tests.yml
   :alt: GitHub Build Status

.. image:: https://codecov.io/gh/e0404/matRad/graph/badge.svg?token=xQhUQLu4FK
   :target: https://codecov.io/gh/e0404/matRad
   :alt: codecov


Welcome to the |matRad_logo_header2| documentation
--------------------------------------------------

**Date**: |today| **Version**: |version|

|matRad_logo| is an open source software for radiation treatment planning of intensity-modulated photon, proton, helium and carbon ion therapy, with experimental modules for brachytherapy and very-high energy electrons (VHEE).
|matRad_logo| is developed for educational and research purposes; it is entirely written in MATLAB.

This guide is the main source of information for users working with, and developers contributing to matRad.
If you do not already have a local copy of |matRad_logo| or you want to know how to get started, have a look at the Quick Setup Guide.
For detailed technical information about |matRad_logo| and its functions please check out the Technical Documentation.

Please send us an email if you want to receive the |matRad_logo| newsletter that informs about the latest developments on an irregular basis.

Quick Navigation
^^^^^^^^^^^^^^^^

+----------------+--------------------------------+-----------------+
| :ref:`about`   | :ref:`Quick Setup <settingup>` | :ref:`techdoc`  |
+================+================================+=================+
| |icon_about|   | |icon_setup|                   | |icon_techdoc|  |
+----------------+--------------------------------+-----------------+

|matRad_logo_header3| Webinars
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

If you like video lectures and tutorials, you can also have a look at the recording of the |matRad_logo| webinar at the brown bag medical physics seminar at Massachusetts General hospital on `Youtube <https://www.youtube.com/watch?v=40_n7BIqLdw>`_.

..  youtube:: 40_n7BIqLdw

Centers using |matRad_logo_header3|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

On `Google Maps <https://www.google.com/maps>`_ we are maintaining a `list of matRad user groups <https://tinyurl.com/matRadMap>`_.
Please let us know if we can include your center, or if you have discontinued the usage of |matRad_logo| so we can remove you from the list.

.. toctree::
   :maxdepth: 4
   :caption: Overview
   :glob:
   :includehidden:

   overview/about
   overview/cite
   overview/faq
   Changelog <https://github.com/e0404/matRad/blob/master/CHANGELOG.md>

.. toctree::
   :hidden:

   genindex

.. toctree::
   :maxdepth: 4
   :caption: Setting Up
   :includehidden:

   setup/requirements
   setup/download
   quickstart/index


.. toctree::
   :maxdepth: 6
   :caption: Technical Documentation

   guide/index
   api/index
   mat-modindex