Main Page

From UCL HEP PBT Wiki

Jump to: navigation, search
m
(Undo revision 14971 by VeldaApple7 (talk))
 
Line 1: Line 1:
-
== Introduction ==
+
== <span style="color:#000080"> Introduction </span> ==
-
----
+
 
This is a tutorial about applications of GEANT4 to medical physics. The GEANT4 is installed on the HEP Linux cluster at UCL. You will need an account on that cluster to be able to use this software, run example tutorials and create your own applications.
This is a tutorial about applications of GEANT4 to medical physics. The GEANT4 is installed on the HEP Linux cluster at UCL. You will need an account on that cluster to be able to use this software, run example tutorials and create your own applications.
-
== Accounts and Registration ==
+
== <span style="color:#000080"> Accounts and Discussion forum </span> ==
-
----
+
-
=== Getting a computing account ===
+
-
----
+
-
Apply for a computing account on the HEP Linux cluster by sending e-mail to [mailto:support@hep.ucl.ac.uk HEPComputingSupport]. In your e-mail you have to state the reason for your application (e.g. medical physics student who will use GEANT4 on the HEP cluster).
+
-
You will receive an e-mail from the HEP computing support with your username and password. Now you can log in to the HEP cluster “plus1” via  ssh username@plus1.hep.ucl.ac.uk.
+
* Getting a computing account
 +
Apply for a computing account on the HEP Linux cluster by sending e-mail to UCL HEP Computing Support. In your e-mail you have to state the reason for your application (e.g. medical physics student who will use GEANT4 on the HEP cluster).
-
=== Where to get help ===
+
You will receive an e-mail from the HEP computing support with your ''username'' and ''password''. Now you can log in to the HEP cluster plus1 via  ssh ''username''@plus1.hep.ucl.ac.uk. Your personal area on plus1 cluster will be at /home/''username''/.
-
----
+
-
You can write to the discussion section.
+
-
== The basics of GEANT4 ==
+
* Discussion about the tutorials 
-
----
+
-
GEANT4 is a toolkit for simulating the passage of particles through matter. The user creates his/her own simulation application using GEANT4 tools. The tools are base classes. There are eight base classes. 
+
-
* Three classes are mandatory  
+
You can write to the discussion forum by clicking the <span style="color:#0000ff"> discussion </span> tab at the top of the page.
 +
   
 +
== <span style="color:#000080"> The basics of GEANT4 </span> ==
-
; G4VUserDetectorConstruction
+
GEANT4 is a toolkit for simulating the passage of particles through matter. You can use GEANT4 by creating your own simulation applications using the available GEANT4 tools.
-
: Describe the experimental setup, geometry and materials
+
-
; G4VUserPhysicsList
+
-
: Define particles, physics processes and range cuts
+
-
; G4UserPrimaryGeneratorAction
+
-
: Describe particle source, source dimensions, initial position, energy spectrum, angular distributions
+
-
* The rest are optional
+
* [[Introduction to GEANT4]] will help you understand the basics of GEANT4 and the necessary ingredients to write your own application. 
 +
* Useful links:
 +
** [http://geant4.web.cern.ch/geant4/UserDocumentation/UsersGuides/ForApplicationDeveloper/html/ Geant4 User's Guide for Application Developers]
 +
** [http://geant4.web.cern.ch/geant4/G4UsersDocuments/UsersGuides/PhysicsReferenceManual/html/PhysicsReferenceManual.html Physics Reference Manual]
 +
** [http://www-geant4.kek.jp/Reference/10.00/index.html GEANT4 Classes]
 +
** [http://hypernews.slac.stanford.edu/HyperNews/geant4/cindex GEANT4 hypernews]
 +
** [http://www-geant4.kek.jp/LXR/ Geant4 Cross Reference]
 +
** [http://geant4.web.cern.ch/geant4/UserDocumentation/UsersGuides/FAQ/html/index.html Frequently Asked Questions]
-
; G4UserRunAction
+
== <span style="color:#000080"> Data analysis software </span> ==
-
: Define and store histograms
+
-
; G4UserEventAction
+
-
: Event selection and analysis of simulation data
+
-
; G4UserStackingAction
+
-
: Customize priority of tracks
+
-
; G4UserTrackingAction
+
-
: Decide whether a trajectory should be stored or not
+
-
; G4UserSteppingAction
+
-
: Kill, suspend, postpone a track
+
-
You can create your own classes which are derived from the base classes. All of them should be registered with the G4RunManager. In function main() which is the skeleton of your simulation code you instantiate G4RunManager and notify it of your mandatory and optional classes.
+
These tutorials use ROOT to analyse data. Useful links:
 +
* [http://root.cern.ch/drupal/content/root-users-guide-534 ROOT User's Guide]
 +
* [http://root.cern.ch/root/html534/guides/primer/ROOTPrimer.html ROOT Primer]
 +
* [http://root.cern.ch/root/html/tutorials/ ROOT tutorials]
-
== Basic tutorials ==
+
Similarly, data can be analysed using MATLAB. This is a link to interactive introduction to MATLAB:
-
----
+
* [http://www.see.ed.ac.uk/teaching/courses/matlab/ MATLAB introduction]
-
This section includes several basic tutorials:
+
-
* [[Monoenergetic photon pencil beam]] is a simple code which shows the dose distribution in water along the incident monoenergetic photon beam.
+
== <span style="color:#000080"> Basic tutorials </span> ==
-
* [[Monoenergetic proton pencil beam]] is a simple code which shows the dose distribution in water along the incident monoenergetic proton beam.
+
-
* [[Proton beam with realistic geometry]] is a more complex code with realistic geometry of the proton beam. It shows the dose distribution in water along the beam. There are two options for the beam geometry:  
+
-
** Gaussian beam profile
+
-
** Beam profile from phase space files
+
-
* [[Several proton beams with spread out Bragg peaks]] is a complex code which shows the dose distribution in water with several incident monoenergetic proton beams. 
+
 +
This section includes several basic tutorials:
-
=== Monoenergetic photon pencil beam incident on a water cube ===
+
* [[Monoenergetic photon pencil beam]] is a simple code which shows the dose deposition in water along the incident monoenergetic photon beam.
-
----
+
* [[Monoenergetic proton pencil beam]] is a simple code which shows the dose deposition in water along the incident monoenergetic proton beam.  
-
* Introduction
+
* [[Proton beam with realistic geometry]] is a simple code with realistic geometry of the proton beam. The primary particles are generated with initial energy, position and direction described by Gaussian distributions. Computed is the dose deposition in water along the beam.  
-
 
+
* [[Several proton beams with spread out Bragg peaks]] is a simple code which shows the dose deposition in water from several incident monoenergetic proton beams.
-
This example shows the dose distribution in water along the incident photon beam. The beam hits the water cube surface and deposits a dose under the surface of the water. The volume of the water cube is divided into voxels. At each voxel the dose contribution from the pencil beams is summed up and yields the total dose along the beam axis.  
+
* [[Electron beam using phase-space files]] is a simple code which shows the dose deposition in water along the incident electron beam using phase-space data files.
-
 
+
-
* Setting up the environment
+
-
 
+
-
; Connect to plus1 cluster and create folder PhotonPencilBeam in your area
+
-
 
+
-
<blockquote>
+
-
<span style="color:#800000"> ssh username@plus1.hep.ucl.ac.uk </span> <br/>
+
-
<span style="color:#800000"> cd /home/username/ </span> <br/>
+
-
<span style="color:#800000"> mkdir PhotonPencilBeam </span> <br/>
+
-
<span style="color:#800000"> cd PhotonPencilBeam </span>
+
-
</blockquote>
+
-
 
+
-
; Setup GEANT4 environment
+
-
 
+
-
<blockquote>
+
-
<span style="color:#800000"> source GEANT4 script </span>
+
-
</blockquote>
+
-
 
+
-
* How to get the code
+
-
 
+
-
; Copy the code to your area
+
-
 
+
-
<blockquote>
+
-
<span style="color:#800000"> cp -r /vasileva/BasicExamples/PhotonPencilBeam_source /username/PhotonPencilBeam/ </span>
+
-
</blockquote>
+
-
 
+
-
* How to run the code  
+
-
 
+
-
; Inside /username/PhotonPencilBeam/ create directory
+
-
 
+
-
<blockquote>
+
-
<span style="color:#800000"> mkdir PhotonPencilBeam_build </span>
+
-
</blockquote>
+
-
 
+
-
; Change to this directory and run cmake and make to build the PhotonPencilBeam tutorial
+
-
 
+
-
<blockquote>
+
-
<span style="color:#800000"> cd PhotonPencilBeam_build </span> <br/>
+
-
<span style="color:#800000"> cmake -DGeant4_DIR=/unix/pbt/Software/..../ /username/PhotonPencilBeam_source/ </span> <br/>
+
-
<span style="color:#800000"> make </span>
+
-
</blockquote>
+
-
 
+
-
* How to analyze data
+
-
 
+
-
=== Monoenergetic proton pencil beam incident on a water cube ===
+
-
----
+
-
* Introduction
+
-
* Setting up the environment
+
-
* How to get the code
+
-
* How to run the code
+
-
* How to analyze data
+
-
* Comparison with data from The Clatterbridge Cancer Centre
+
-
 
+
-
=== Proton beam with realistic geometry incident on a water cube ===
+
-
----
+
-
==== Gaussian beam profile ====
+
-
----
+
-
* Introduction
+
-
* Setting up the environment
+
-
* How to get the code
+
-
* How to run the code
+
-
* How to analyze data
+
-
* Comparison with data from The Clatterbridge Cancer Centre
+
-
 
+
-
==== Beam profile from phase space files ====
+
-
----
+
-
* Introduction
+
-
* Setting up the environment
+
-
* How to get the code
+
-
* How to run the code
+
-
* How to analyze data
+
-
* Comparison with data from The Clatterbridge Cancer Centre
+
-
=== Several proton beams with spread out Bragg peaks ===
+
== <span style="color:#000080"> Advanced tutorials </span> ==
-
----
+
-
* Introduction
+
-
* Setting up the environment
+
-
* How to get the code
+
-
* How to run the code
+
-
* How to analyze data
+
-
== Advanced tutorials ==
+
This section includes several advanced tutorials:
-
----
+
-
=== Cherenkov simulation ===
+
-
----
+
-
* Introduction
+
-
* Setting up the environment
+
-
* How to get the code
+
-
* How to run the code
+
-
* How to analyze data
+
-
=== Computed tomography ===
+
* [[Computed tomography]]
-
----
+
* [[High-precision dosimetry]]
-
* Introduction
+
-
* Setting up the environment
+
-
* How to get the code
+
-
* How to run the code
+
-
* How to analyze data
+
-
=== High-precision dosimetry ===
+
== <span style="color:#000080"> Installing GEANT4 locally </span> ==
-
----
+
-
* Introduction
+
-
* Setting up the environment
+
-
* How to get the code
+
-
* How to run the code
+
-
* How to analyze data
+
-
== Installing GEANT4 software locally ==
+
* [[Downloading the Geant4 package]]
-
----
+
* [[Linux terminal]]
 +
* [[Installing Geant4]]
 +
* [[Updating Geant4]]
 +
* [[Running an example]]

Latest revision as of 10:21, 26 May 2016

Personal tools