about matRad - e0404/matRad GitHub Wiki
matRad is an open source software for radiation treatment planning of intensity-modulated photon, proton, and carbon ion therapy. matRad is developed for educational and research purposes. It is entirely written in MATLAB.
Please send us an email if you want to receive the matRad newsletter that informs about the latest developments on an irregular basis.
matRad comprises
- MATLAB functions to model the entire treatment planning workflow
- Example patient data
- Physical and biological base data for all required computations
In particular, we provide functionalities for
- Ray tracing
- Photon dose calculation
- Proton dose calculation
- Carbon ion dose calculation (including 3D RBE modeling)
- Inverse planning (based on physical dose and biological effect)
- Multileaf collimator sequencing
- Basic treatment plan visualization and evaluation
matRad is constantly evolving. If you are looking for a special feature do not hesitate and get in touch.
A Wiki documentation is under constant development.
If you have any questions or wish to contribute to the development of matRad, you can either write an email to [email protected], use the GitHub functionalities to file a new issue, or directly fork the matRad repository and send pull requests with your own custom developments. What are you waiting for?
matRad development is driven by the research group Radiotherapy Optimization within the Division of Medical Physics in Radiation Oncology at the German Cancer Research Center DKFZ in Heidelberg. Contributors at the German Cancer Research Center and beyond include
- Mark Bangert (DKFZ)
- Eduardo Cisternas (Universidad Católica de Chile)
- Hubert Gabrys (DKFZ)
- Oliver Jäkel (DKFZ/HIT/Heidelberg University Clinic)
- Thomas Klinge (DKFZ)
- Andrea Mairani (CNAO/HIT)
- Henning Mescher (DKFZ)
- Niklas Wahl (DKFZ)
- Hans-Peter Wieser (DKFZ, now LMU)
- Peter Ziegenhein (ICR)
We are actively looking for beta testers that can provide external feedback on our code and developers that would like to take an active role in the future. Do not hesitate and get in touch.
matRad is offered as a compilation with the Ipopt software package for large-scale nonlinear optimization. All the elements of the compilation of matRad and Ipopt are free software. You can redistribute and/or modify matRad’s source code provided as files with .m and .mat extension under the terms of the GNU GENERAL PUBLIC LICENSE Version 3 (GPL v3). You can also add to matRad the Ipopt functionality by using the precompiled mex files of the Ipopt optimizer in object code version which are licensed under the Eclipse Public License Version 1.0 (EPL v1.0), also made available for download via https://github.com/coin-or/Ipopt.
In addition, we provide a MATLAB standalone version of the compilation of matRad and Ipopt, where the files of matRad and Ipopt are licensed under GPL v3 and EPL v1.0 respectively. The MATLAB standalone version is meant to be used by students for learning and practicing scientific programming.
matRad is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
Please note that we treat the compilation of matRad and Ipopt as separate and independent works (or modules, components, programs). Therefore, to the best of our understanding, the compilation of matRad and Ipopt is subject to the "Mere Aggregation" exception in section 5 of the GNU v3 and the exemption from "Contributions" in section 1. b) ii) of the EPL v1.0. Should this interpretation turn out to be not in compliance with the applicable laws in force, we have provided you with an additional permission under GNU GPL version 3 section 7 to allow you to use the work resulting from combining matRad with Ipopt.
You will receive a copy of the GPL v3 and a copy of the EPL v1.0 in the file LICENSES.txt along with the compilation. If not, see http://www.gnu.org/licenses/ and/or http://opensource.org/licenses/EPL-1.0/.
