You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
To get a local copy of `matRad <https://github.com/e0404/matRad>`_ you have two options:
9
+
10
+
.. contents::
11
+
:depth: 1
12
+
:local:
13
+
14
+
Cloning the |matRad_logo_header2| Repository
15
+
--------------------------------------------
16
+
17
+
We encourage everybody working with the code to get familiar with ``git``. Using the git workflow does not allow more sophisticated code development and collaboration with the |matRad_logo| development team, but also facilitates keeping a history of changes and integrating updates regularly. If you have never worked with a git repository before, you might want to have a look at the `github guides <https://guides.github.com/>`_ first and rely on a software with a graphical user interface (such as GitHub Desktop) to manage your local |matRad_logo| copy.
18
+
19
+
If you follow the instructions on cloning the repository, you will not only get a local copy of the |matRad_logo| source ode, but get a copy (a "clone") of the entire repository, including all its history. This is part of the decentralized philosophy of git, where each copy is its own repository with which you can work independently, and which you can later synchronize with the original repository (or others). The originial remote repository, in this case `<https://github.com/e0404/matRad.git>`_ (HTTPS) or `<[email protected]:e0404/matRad.git>`_ (SSH), is usually refered to as "origin" or "upstream" repository. git provides the necessary syncing capabilities as "pulling" and "pushing" from/to a remote repository.
20
+
21
+
If you plan to contribute and/or publish your changes on GitHub, follow below instructions to create a fork. If you only plan to pull some updates from the main repository, you can skip the forking step and directly clone the repository. Nothing will be lost then: If you decide later to contribute, you can always delay creation of a fork to contribute to the main repository.
22
+
23
+
24
+
Forking |matRad_logo_header3|
25
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
26
+
27
+
A fork serves as a second personal online copy of the repository within your GitHub Account. Forks are mainly used to propose changes to the original repository, or to use it as a starting point for a derived project. Forking a repository allows you to freely experiment with changes without affecting the original project, and it is a common practice in open source software development.
28
+
29
+
.. note::
30
+
31
+
GitHub Forks are usually the only way to contribute to a GitHub project within normal git workflow practices, as most upstream repositories (including the |matRad_logo| repository) will not allow you to push changes directly to the main repository, and there are no other mechanisms to propose changes from other remote repositories.
32
+
33
+
Forks can be created directly from the repository main page on GitHub. To create a fork of the |matRad_logo| repository, follow these steps:
34
+
Afterwards your fork of |matRad_logo| will be available under ``https://github.com/YOURGITHUBUSERNAME/matRad``.
35
+
36
+
Cloning |matRad_logo_header3|
37
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
38
+
39
+
You can `clone <https://help.github.com/articles/cloning-a-repository/>`_ either the main repository or your fork of matRad. With the command line, you can clone the repository with::
This will clone the main repository in the folder ``matRad``. If you want to clone your fork, replace ``e0404`` in the URL with your GitHub Username. The ``--recurse-submodules`` option is not necessary, but will also clone other dependencies of |matRad_logo| (like our unit testing framework).
44
+
45
+
The repository you clone with the command above will be referred to as "origin" by git by default. You can add further remotes (like your fork) with::
To get a copy of |matRad_logo| you can either download the *.zip folder from the `matRad repository on Github <https://github.com/e0404/matRad>`_ or use `this link <https://github.com/e0404/matRad/archive/master.zip>`_.
54
+
55
+
Once you downloaded the *matRad.zip* folder you can unzip the files to your desired location.
Welcome to the |matRad_logo_header2| documentation
55
42
-------------------------------------------------
56
43
57
44
**Date**: |today| **Version**: |version|
58
45
59
46
|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).
60
-
matRad is developed for educational and research purposes; it is entirely written in MATLAB.
47
+
|matRad_logo| is developed for educational and research purposes; it is entirely written in MATLAB.
61
48
62
49
This guide is the main source of information for users working with, and developers contributing to matRad.
63
-
If you do not already have a local copy of matRad or you want to know how to get started, have a look at the Quick Setup Guide.
64
-
For detailed technical information about matRad and its functions please check out the Technical Documentation.
50
+
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.
51
+
For detailed technical information about |matRad_logo| and its functions please check out the Technical Documentation.
65
52
66
-
Please send us an email if you want to receive the matRad newsletter that informs about the latest developments on an irregular basis.
53
+
Please send us an email if you want to receive the |matRad_logo| newsletter that informs about the latest developments on an irregular basis.
If you like video lectures and tutorials, you can also have a look at the recording of the matRad webinar at the brown bag medical physics seminar at Massachusetts General hospital on `Youtube <https://www.youtube.com/watch?v=40_n7BIqLdw>`_.
67
+
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>`_.
81
68
82
69
.. youtube:: 40_n7BIqLdw
83
70
84
-
Centers using |matRad_logo_subheader|
71
+
Centers using |matRad_logo_header3|
85
72
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
86
73
87
74
On `Google Maps <https://www.google.com/maps>`_ we are maintaining a `list of matRad user groups <https://tinyurl.com/matRadMap>`_.
88
-
Please let us know if we can include your center, or if you have discontinued the usage of matRad so we can remove you from the list.
75
+
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.
If you have MATLAB you can just `get a local copy of the source code <How-to-get-a-local-copy>`_. Then you have to choose whether you want to `use the GUI <How-to-execute-matRadGUI>`_ or `execute the main script <How-to-execute-matRad>`_.
21
+
If you have MATLAB you can just :ref:`get a local copy of the source code <get_code>`. Then you have to choose whether you want to :ref:`use the GUI <run_gui>` or :ref:`execute the main script <run_script>`.
0 commit comments