Merge pull request #47 from Jhonatanc29/master

IAEA Phase Spaces

parameters/source/phasespace.rst

@@ -133,31 +133,51 @@ While TOPAS can save the current TOPAS time to a phase space file, this time is
 A future version of TOPAS will provide more tools to synchronize and check playback time features.
 
 
-IAEA phase space files:
-
-The IAEA has a repository of phase space files generated by simulation of the treatment head of various models of linear accelerator treatment heads using different Monte Carlo systems. 
-Phase-space files uploaded to the IAEA repository before September, 2021 are known as legacy files. Files uploaded after September, 2021 are written in a revised format. 
-All files that conform to the revised IAEA specification can be read with TOPAS (version 3.7). 
-The link to the repository is https://www-nds.iaea.org/phsp/phsp.htmlx. 
-
-Most legacy phase-space files from the repository can be read with TOPAS.
-Some legacy files differ in format and require special handling.
-We call these malformed IAEA phase space files.
-A few legacy files are not read with TOPAS.
-The following table lists the legacy phase-space files from the repository that are not read by TOPAS.
-
-=============================================   ======================================================================================
-Phase-space file in IAEA repository 	         Reason the file is not read with TOPAS
-X-ray beams…                                    
-Elekta_Precise_25mv_part(1a-b,2a-b,3a-b,4a-b)	Number of scored particles listed in the header does not match the number of particles counted in the phase-space file
-Siemens_Primus_6mv_1.2x1.2	                     First Particle is not a new history
-Siemens_Primus_6mv_ 1x1 	                     First Particle is not a new history
-Varian_Clinac_600C_6MV_ 10x10	                  Number of scored particles listed in the header does not match the number of particles counted in the phase-space file
-Varian_TrueBeam6MV_(1,2,3,4,5,6)	               First Particle does not have the new history flag set
-Electron beams…
-Varian_Clinac_2100CD_6MeV_10x10	               Number of scored particles listed in the header does not match the number of particles counted in the phase-space file
-Varian_Clinac_2100CD_9MeV_10x10	               Number of scored particles listed in the header does not match the number of particles counted in the phase-space file
-===================================             ======================================
+Phase-space files in the IAEA repository
+
+The IAEA has a repository of phase-space files generated by simulation of the treatment head of various models of linear accelerator treatment heads using various Monte Carlo systems. 
+Major effort has been put in by those who prepared these files, taking the time to procure the geometry and source details for the simulation, both from fastidious measurements and manufacturer-supplied specifications, running simulations with a lot of histories to generate enough particles to use for precise calculations, and validating the results against measurement. 
+TOPAS users may benefit from using these files; however,  be advised that these files have not been validated by the TOPAS team. 
+
+The link to the IAEA repository is https://www-nds.iaea.org/phsp/phsp.htmlx. 
+We strongly recommend that users perform their own validation of the phase-space files they download from the IAEA website. 
+Phase-space files uploaded to the IAEA repository before 2022 are known as legacy files. 
+Most legacy phase-space files from the repository can be read with TOPAS. 
+Development of a revised format by a group with representation from IAEA and developers of several Monte Carlo systems began in 2021. 
+All files that conform to the revised IAEA phase-space file format specification will be readable by TOPAS. 
+
+The following is a plot of the electron energy distributions for the legacy files that can be read with TOPAS. 
+
+.. image:: PhaseSpaceElectron.png
+
+The following is a plot of the x-ray energy distributions for the legacy files that can be read with TOPAS. 
+
+.. image:: PhaseSpaceXRays.png
+
+The following legacy phase-space files from the repository require special handling to run with TOPAS:
+
+=================================================   ======================================
+Phase-space file in IAEA repository                 Comment
+=================================================   ======================================                          
+X-ray beams
+Elekta_Precise_25mv_part(1a-b,2a-b,3a-b,4a-b)	    download file a and b, and join in terminal before running with Topas:   
+                                                    cat ELEKTA_PRECISE_25mv_part1_a.IAEAphsp ELEKTA_PRECISE_25mv_part1_b.IAEAphsp > ELEKTA_PRECISE_25mv_part1.IAEAphsp
+=================================================   ======================================
+
+The following legacy phase-space files are not able to be read by TOPAS. Comment shows what type of error TOPAS reports when trying to read the file, but some of these files have additional issues beyond that shown in the comment:
+
+=================================================   ======================================
+Phase-space file in IAEA repository                 Comment
+=================================================   ======================================                          
+X-ray beams               
+Siemens_Primus_6mv_1.2x1.2                          First Particle is not a new history
+Siemens_Primus_6mv_1x1                              First Particle is not a new history
+Varian_Clinac_600C_6MV_10x10                        Number of scored particles listed in the header does not match the number of particles counted in the phase-space file
+Varian_TrueBeam6MV_(1,2,3,4,5,6)                    First Particle does not have the new history flag set
+Electron beams
+Varian_Clinac_2100CD_6MeV_10x10                     Number of scored particles listed in the header does not match the number of particles counted in the phase-space file
+Varian_Clinac_2100CD_9MeV_10x10                     Number of scored particles listed in the header does not match the number of particles counted in the phase-space file
+=================================================   ======================================
 
 Handling of Malformed IAEA phase space files: