Skip to content

How to get a local copy

palkma edited this page Nov 5, 2020 · 10 revisions

Get a local copy of matRad

To get a local copy of matRad you have two options:

  1. Download the .zip folder
  2. Clone the Repository

Downloading the matRad.zip folder

To get a copy of matRad you can either download the *.zip folder from the matRad repository on Github or use this link.

Once you downloaded the matRad.zip folder you can unzip the files to your desired location and execute matRad.

Cloning the matRad Repository

For more sophisticated code development and collaboration with the matRad development team, we recommend using the git workflow. If you have never worked with a git repository, you might want to have a look at the github guides first.

If you want to use the git workflow, the first step is to fork the matRad repository. Afterwards you can clone your fork of matRad and locally execute the code and work on code developments. If the included MCsquare or ompMC binaries are not working on your system (or you want to change their source code), you can also clone the submodules with git clone --recurse-submodules which are then used by matRad to compile the binaries from source.

Having your personal fork on github has the advantage that you can keep track of your own developments, constantly receive updates from the master git repository, and eventually send pull requests for your changes to be incorporated in the master git repository. We are excited about any potential contribution. What are you waiting for?