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 ===
+
* 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).
-
Apply for a computing account on the HEP Linux cluster by sending e-mail to support@hep.ucl.ac.uk. In your e-mail you have to state the reason for your application (i.e. medical physics student who will use the GEANT4 software).
+
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 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.
+
* Discussion about the tutorials  
-
=== Where to get help ===
+
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> ==
-
== The basics of GEANT4 ==
+
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.
-
----
+
-
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:  
+
* [[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]
-
* Three classes are mandatory:
+
== <span style="color:#000080"> Data analysis software </span> ==
-
; G4VUserDetectorConstruction
+
These tutorials use ROOT to analyse data. Useful links:
-
: Describe the experimental setup, geometry and materials
+
* [http://root.cern.ch/drupal/content/root-users-guide-534 ROOT User's Guide]
-
; G4VUserPhysicsList
+
* [http://root.cern.ch/root/html534/guides/primer/ROOTPrimer.html ROOT Primer]
-
: Define particles, physics processes and range cuts
+
* [http://root.cern.ch/root/html/tutorials/ ROOT tutorials]
-
; G4UserPrimaryGeneratorAction
+
-
: Describe particle source, source dimensions, initial position, energy spectrum, angular distributions
+
-
* The rest are optional classes:
+
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]
-
; G4UserRunAction
+
== <span style="color:#000080"> Basic tutorials </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 the user simulation code you instantiate G4RunManager and notify it of your mandatory and optional classes.
+
This section includes several basic tutorials:
-
== Basic examples ==
+
* [[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.
 +
* [[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. 
 +
* [[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.
-
=== Monoenergetic photon pencil beam incident on a water cube ===
+
== <span style="color:#000080"> Advanced tutorials </span> ==
-
* Introduction
+
This section includes several advanced tutorials:
-
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.
+
* [[Computed tomography]]
 +
* [[High-precision dosimetry]]
-
* Setting up the environment
+
== <span style="color:#000080"> Installing GEANT4 locally </span> ==
-
** Connect to plus1 cluster and create a folder PhotonPencilBeam in your local area:
+
* [[Downloading the Geant4 package]]
-
 
+
* [[Linux terminal]]
-
<blockquote>
+
* [[Installing Geant4]]
-
ssh username@plus1.hep.ucl.ac.uk
+
* [[Updating Geant4]]
-
mkdir PhotonPencilBeam
+
* [[Running an example]]
-
cd PhotonPencilBeam
+
-
</blockquote>
+
-
 
+
-
** Setup GEANT4 environment:
+
-
 
+
-
<blockquote>
+
-
source ... (GEANT4 script)
+
-
</blockquote>
+
-
 
+
-
* How to get the code
+
-
 
+
-
** Copy the code to your area:
+
-
 
+
-
<blockquote>
+
-
cp /vasileva/BasicExamples/PhotonPencilBeam_source /username/PhotonPencilBeam/
+
-
</blockquote>
+
-
 
+
-
* How to run the code
+
-
 
+
-
** Inside /username/PhotonPencilBeam/ create a folder:
+
-
 
+
-
<blockquote>
+
-
mkdir PhotonPencilBeam_build
+
-
</blockquote>
+
-
 
+
-
** Change to this build directory and run cmake and make to build the PhotonPencilBeam example:
+
-
 
+
-
<blockquote>
+
-
cd PhotonPencilBeam_build
+
-
cmake -DGeant4_DIR=/unix/pbt/Software/..../ /username/PhotonPencilBeam_source/
+
-
make
+
-
</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 ===
+
-
 
+
-
* 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 ===
+
-
 
+
-
* Introduction
+
-
* Setting up the environment
+
-
* How to get the code
+
-
* How to run the code
+
-
* How to analyze data
+
-
 
+
-
== Advanced examples ==
+
-
----
+
-
 
+
-
=== Cherenkov simulation ===
+
-
 
+
-
* Introduction
+
-
* Setting up the environment
+
-
* How to get the code
+
-
* How to run the code
+
-
* How to analyze data
+
-
 
+
-
=== Computed tomography ===
+
-
 
+
-
* Introduction
+
-
* Setting up the environment
+
-
* How to get the code
+
-
* How to run the code
+
-
* How to analyze data
+
-
 
+
-
=== High-precision dosimetry ===
+
-
 
+
-
* Introduction
+
-
* Setting up the environment
+
-
* How to get the code
+
-
* How to run the code
+
-
* How to analyze data
+
-
 
+
-
== Installing GEANT4 software locally ==
+
-
----
+

Latest revision as of 10:21, 26 May 2016

Personal tools