User Manual for egs inprz, a GUI for the NRC RZ user
Contents
1. 0 1 1 0 1 E r Turn ON Bound Compton scattering m Turn ON Rayleigh scattering Execute PreviewRZ Print Figure 15 Transport Parameter per Regions Input for the RZ EGSnrc User Codes 5 INPUT BLOCKS DESCRIPTION AND SCREENSHOTS egs inprz a GUI for the NRC RZ user codes 27 5 9 The Variance Reduction Tab In this tab the user can define the parameters for the different variance reduction tech niques incorporated in the specific user codes Techniques like electron range rejection bremsstrahlung splitting and Russian Roulette are now implemented in EGSnrc Pathlength biasing and photon forcing are implemented in all user codes except FLURZnrc which only includes photon forcing Additionally photon cross section enhancement is available in DOS RZnrc and CAVRZnrc and a photon splitting technique is also available in CAVRZnrc See the NRC User Codes Manual for information on these techniques NRCC report PIRS 702 1 d dosrznre_template egsinp GUI for RZ EGSnrc user codes Copyright 2011 NRC Canada Geometry Source Transport Parameter Transport Parameters by Region Variance Reduction Plot Control 4 Ph E m Photon cross section enhancement X Photon Forcing CS Enhancement factor 1 5 start forcing 1 stop forcing 1 aly2. Printer Host Comment Unknown Location Unknown Location Unknown Location Unknown Location Unknown Location Unknown Location Unknown Location Unknown Location O Print to file Printer settings m Paper format Print in color if available Portrait Print in grayscale E Letter 8 5x11 inches 216x279 mm Options Print all Print first page first Print last page first O Print range Number of copies ht Cancel Figure 2 Printer Setup Dialog on SuSE Linux 10 3 KDE 3 5 9 3 USING EGS_INPRZ egs inprz a GUI for the NRC RZ user codes 11 3 7 Compiling the RZ user codes When one modifies the user codes these need to be re compiled The user can perform this operation from within the GUI by pressing the Compile button on the lower left corner of the GUI see for instance figure 5 in section 5 1 On the General Information tab there is a Target radio button group box where one can choose the type of compilation desired By default it is set to optimization which uses the optimization option defined in the active config file generated during the EGSnrc installation process or the configuration utility available in all the EGSnrcMP GUI s The other available options are no optimization debug and clean Optimization is recommended for production runs after the user code and the input file have been thoroughly tested 3 8 Executing the RZ user cod
3. r planes information 34 cylinder information amp slabs thickness om 1 gadius em medium start Z stop Z start R 10 1 H205211CRU 1 60 1 50 2 AIRS21ICRU 1 11 1 PPEPPEPEE o E Es Es Execute J PreviewRZ J Print J Compile Save Exit Help About J Figure 8 Geometry Input for the RZ EGSnrc User Codes 5 INPUT BLOCKS DESCRIPTION AND SCREENSHOTS egs inprz a GUI for the NRC RZ user codes 19 5 5 The Cavity Tab This tab is only enabled for the user code CAVRZnrc If the input method selected in the geometry tab upper left corner is groups or individual the user can define the regions comprising the cavity there If on the other hand the input method selected is cavity description then the rest of the input fields in the the geometry tab are disabled and the the whole geometry input occurs here The materials for the chamber wall and the electrode can be selected from available media in the current PEGS4 data file This option was useful for early calculations but is not adequate for chambers in which one wants to include much detail Beware If the input method is cavity description the material name inside the cavity is assumed to be AIR by the user code CAVRZnrc i e CAVRZnrc will searc
4. 3 1 Running egs inprz After installing EGSnrc egs inprz is located on HEN HOUSE bin my machine my machine stands for the name of the configuration used to build the GUI For more information about configurations the user is referred to the PIRS 877 report on the new multi platform environment 2 On Windows the user can invoke directly the binary executable from a DOS console since its location will be on the user s PATH environment variable If requested by the user there will be also shortcuts to the GUI s distributed with the EGSnrc system on the Desktop and Start Menu On Unix Linux the user can also invoke directly the binary executable from a shell console since its location is added to the user s PATH environment variable when the cor responding egsnrc cshrc bashrc additions is sourced which must have been done after installing the EGSnrc system The alias egsinprz is also available which points to HEN HOUSE bin my machine egs inprz and starts the GUI in the background If requested by the user shortcuts for the KDE desktop environment are also created by the installation GUI Once all the necessary information is entered the user can perform different operations from within the GUI provided the input file has been saved to the disk since all other operations use the disk version of the input file 3 2 Reading EGSnrc RZ input files Existing input files can be read directly from the command line by passing the file name
5. aly Regions to apply CS Enhancement r Photon pathlength biasing 3 DOSRZnrc only biasing parameter C 0 0000 start stop A 1 r Russian Roulette photons Z Depth 0 0000 Fraction 0 0000 HB C Bremsstrahlung splitting Russian Roulette charged particles Execute J PreviewRZ Print Compile Save Exit Help Figure 16 Variance Reduction Parameters for the RZ EGSnrc User Codes Last edited 2011 05 09 20 49 18 5 INPUT BLOCKS DESCRIPTION AND SCREENSHOTS page 28 NRCC Report PIRS 801 5 10 The Plot Control Tab This input block is only relevant for two of the user codes DOSRZnrc and FLURZnrc DOSRZnrc has a section of inputs to control plotting of dose vs depth radius results see figure 17 d dezrznrc template egsinp GUI for RZ EGSnrc user codes Copyright 2011 NRC Canada Geometry Source Transport Parameter C Line printer output X External plotter output r External plot type Histogram Primaries and total r Define plot regions radial IX planar IZ 2 10 Execute J PreviewRZ J Print Compile Save JI Exit Help About Figure 17 Plot Inputs for the RZ EGSnrc User
6. as argument i e by invoking egs inprz filename egsinp where the file name can be with or without extension If the file does not exist a warning message is shown and the file name new file egsinp is used instead Note that in this case no input file will exist To have an actual input file and be able to run a calculation the user must have saved it Saving new file egsinp without modifying any entry will leave a default input file for use with the RZ user code dosrznrc mortran Once an existing input file is loaded it is searched to identify the user code it belongs to If no user code is identified DOSRZnrc is used by default Once the user code to be used is known its location becomes the place where the GUI will look for input files Regarding location the EGSnrc system relies on having the input file on the EGSnrc user area i e EGS HOME user code This is so because for execution temporary directories and output files are created moved and deleted and all these operations are relative to the EGS HOME user code location Last edited 2011 05 09 20 49 18 3 USING EGS_INPRZ page 8 NRCC Report PIRS 801 For this reason this GUI will only store input files in the user s EGSnrc area i e EGS HOME user code If the EGSnrc user area does not exist the GUI creates it and issues a warning Input files can be also read in from the GUI s General tab Once the GUI is loaded a list of available egsinp input files i
7. normal iwatch r Dose regions irestart minimum plane maximum plane minimum cylinder total fluence IFISEPICSEPICSREIS maximum cylinder X store data array Execute PreviewRZ Print J Compile Save Exit Help About Figure 6 I O control for the RZ EGSnrc User Codes 5 INPUT BLOCKS DESCRIPTION AND SCREENSHOTS egs inprz a GUI for the NRC RZ user codes 17 5 3 The Monte Carlo Parameter Tab This input tab collects the typical information required in a Monte Carlo simulation like the number of histories to run the initial random number seeds desired statistical accuracy and the maximum CPU time for the calculation There are also more user code specific entries that are enabled or disabled depending on the user code selected An input block required only by the user code DOSRZnrc when the calculation type is pulse height distribution is also included in this tab For other calculation types and user codes this box remains disabled d dosrznrc template egsinp GUI for RZ EGSnre user codes Copyright 2011 NRC Canada p gzinp pyrig General 1 0 control Monte Carlo Geometry Source Transport Parameter OR Type of calculation number of histories 100000 ifull dose and stoppers maximum CPU hours allowed 90 000 statistical accuracy sough
8. on building a source library Setup beam source RIE Execute PreviewRZ Print J Compile save Exit Help About Figure 12 Selecting BEAMnrc as a source 5 INPUT BLOCKS DESCRIPTION AND SCREENSHOTS egs inprz a GUI for the NRC RZ user codes 23 egs_inprz BEAM user code library build only BEAM input file custom M BEAM pegs4 data file 521icru V Weight window for BEAM particles BEAM source options pisT 0 ANGLE o zorrset o XOFFSET 0 YOFFSET 0 Figure 13 BEAMnrc source definition dialog Last edited 2011 05 09 20 49 18 5 INPUT BLOCKS DESCRIPTION AND SCREENSHOTS page 24 NRCC Report PIRS 801 5 7 The Transport Parameters Tab This input section gathers information inherent to the physics of the transport of electro magnetic radiation through matter Threshold energies for photons and electrons electron transport algorithm to be used as well as the cross section data and angular distributions to be used are entries that are defined here By default EGSnrc uses threshold energies given by AP and AE in each region for photons and electrons respectively The electron transport is originally set to the EGSnrc default algorithm which is independent of electron step size The user can also choose to turn on and off other effe
9. the Save or Save amp Erit button in the user s EGSnrc user code area if it doesn t exist it is created automatically and a warning is issued to the user 3 5 Viewing the geometry with previewRZ Once an existing input file has been loaded or created from scratch and saved on the hard drive the user can invoke previewRZ a tool supplied with the EGSnrc distribution which allows one to visualize the geometry and material data see figure 1 The PreviewRZ button placed in the left bottom corner of the GUI see any GUI snapshot in section b becomes enabled if Tcl Tk is installed on your computer the input file exists and there were no errors reading the geometry Pressing this button is equivalent to typing on the command line of a console Windows or Unix Linux HEN HOUSE previewRZ previewRZ name egsinp where the input filename can be entered with or without extension 7 Cavrz Preview 3C egsinp a nix 3C egsinp 12 10 03 0 00000 0 58750 1 17500 0 00000 r LEGEND 0 50510 dick on the colour swatch to change the colour of a material E C226 166 521ICRU 1 01020 AIR521 ICRU POLYSTYS21ICRU DEPTHS AND RADII cm 1 51530 Depths Radii 0 456 0 2044 0 8693 0 3352 2 0695 0 7919 2 02040 2 5255 1475 2 52550 NRC CNRC I z EE MM M pere pef En Figure 1 View of a 3C cylindrical ionization chamber using previewRZ previewRZ is a Tcl Tk scr
10. the advantages of a graphical user interface is the possibility of providing information in an interactive way egs inprz uses this feature extensively by activating so called tool tips when the user positions the mouse over a given area in the GUI A dialog pops up temporarily with information if available about the corresponding input quantity There is also the possibility of activating these tool tips permanently until another action is performed mouse click or key press For this the user must set the focus on the relevant location and press Shift F1 The help text appears immediately it goes away as soon as the user does something else More general information is provided in html format through the Help button located in the lower right corner of the GUI html version of this document egs inprz attemps to run Internet Explorer on Windows and Konqueror or Netscape on Unix Linux to show the document If none of these are available an error message is displayed In that case the user can go to HEN HOUSE gui egs inprz html and load the index page index html with an html browser of his her choice 5 Input blocks description and screenshots In this section we describe briefly the different input blocks that are used in the NRC RZ user codes We have also included screenshots of the different input tabs of the GUI In each of these tabs there are input options common to all the RZ user codes But some of them are specific to one user cod
11. Code DOSRZnrc FLURZnrc has two distinct types of plotting outputs One class of plots gives integral fluence vs position plots in various ways vs depth vs radius The code also ouputs fluence spectra in specified regions see figure 18 5 INPUT BLOCKS DESCRIPTION AND SCREENSHOTS egs inprz a GUI for the NRC RZ user codes 29 d flurznrc_template egsinp GUI for RZ EGSnrc user codes Copyright 2011 NRC Canada Geometry Source Transport Parameter Variance Reduction Plot Control f J Plots for electrons X Plots for photons xj Plots for positrons C Plots for e and e r External plot type Type of integral fluence to plot imam i I r Regions to plot integral fluence vs position r Spectral plot regions radial IX planar IZ t J PreviewRZ Print J Compile Save Exit J Help About Figure 18 Plot Inputs for the RZ EGSnrc User Code FLURZnrc Last edited 2011 05 09 20 49 18 5 INPUT BLOCKS DESCRIPTION AND SCREENSHOTS page 30 NRCC Report PIRS 801 1 D W O Rogers I Kawrakow J P Seuntjens B R B Walters and E Mainegra Hing NRC User Codes for EGSnrc Technical Report PIRS 702 RevC National Research Council of Canada Ottawa Canada 2010 2 I Kawrakow E Mainegra Hing and D W O Rogers EGSnrcMP the multi platform environmen
12. N HOUSE pegs4 data by default Later on when users have created their own data sets they can switch to EGS HOME pegs4 data or any other location of their preference 3 3 Creating EGSnrc RZ input files As mentioned above when starting the RZ GUI the template dosrznrc template egsinp is read in which contains defaults for all possible entries Saving this template under any other name is a possible way for getting started In similar fashion one can switch to another RZ user code see section 5 1 and select the corresponding input template file 3 4 Porting input files between NRC RZ user codes Sometimes different user codes share common input blocks like transport parameters geom etry variance reduction parameters and so on For instance the user might want to run a CAVRZnrc calculation to obtain the dose inside the air cavity of an ion chamber and also run a FLURZnrc calculation to obtain the spectrum inside the cavity for the same cham ber This is easily acomplished with egs_inprz by loading the input file for the CAVRZnrc calculation switching to the other user code input by clicking on the corresponding radio button in the user code group box see figure 5 in section 5 1 One will have to modify 3 USING EGS_INPRZ egs inprz a GUI for the NRC RZ user codes 9 the default entries for the selected user code to suit the user s problem if needed Once the proper entries are made the input file can be saved by clicking on
13. ST x positron DIST charged Oall ANGLE ZOFFSET NRCYCL IPARALLEL PARNUM mPhase space file ummy Execute PreviewRZ Print Compile l Save JI Exit Help About Figure 10 Source Input for the RZ EGSnrc User Codes If the user selects source 21 or 22 the Phase space file edit line becomes enabled and one can either type the name of a phase space file or one can use the Open File Dialog to navigate throught the directories to get the desired file In the latter case the path is stripped from the file name but it is still rembered and properly added to the file name when saving the input file Although EGSnrc accepts phase space files with arbitrary extensions it is customary to use the egsphspl extension for regular phase space files and AEAphsp for phase space files using the IAEA format in this latter case the extension is improtant Although the default filter for searching for files uses these extensions see figure 11 the All 5 INPUT BLOCKS DESCRIPTION AND SCREENSHOTS egs inprz a GUI for the NRC RZ user codes 21 files filter is still available Look in 3iome mainegra egsnrc mp BEAM EX1OMeVe amp e E am Cdegsrun 1773 EX10MeVe irs15 custom egsphspt Bi EX10MeVe egsphsp1 test xsections egsphsp1 File na
14. User Manual for egs inprz a GUI for the NRC RZ user codes Ernesto Mainegra Hing Ionizing Radiation Standards National Research Council of Canada Ottawa K1A OR6 November 26 2015 NRCC Report PIRS 801 RevB id dosrznre_template egsinp GUI for RZ EGSnre user codes Copyright 2011 NRC Canada General 1 0 control Monte Carlo Geometry Source Transport Parameter m Title 80 characters maximum dosrznrc_template depth dose in H20 due to Cobalt beam r Select EGSnrc user code Target User code area Pegs data area CAVRZnrc optimization EGS HOME EGS HOME DOSRZnrc C no optimization O HEN HOUSE HEN HOUSE SPRRZnrc debug Other Other FLURZnre clean EGSnrc input file name egsinp dosrznrc_template egsinp m PEGS4 file name pegs4dat 521 icru pegs4dat r Configuration file gnu 4 conf Configuration Execute J PreviewRZ Print Compile J Save Exit Help About Front page of the egs_inprz GUI for the RZ EGSnrc User Codes ONRC Canada 2013 page 2 NRCC Report PIRS 801 egs inprz a GUI for the NRC RZ user codes 3 Abstract This is the reference user manual for egs_inprz a graphical user interface for the EGSnrc RZ user codes suite It briefly introduces the GUI and describes how to install it and work with it Descriptions and s
15. can now enter the medium and file names for using custom coherent scattering form factors Currently the option for defining an arbitrary file with Compton 5 INPUT BLOCKS DESCRIPTION AND SCREENSHOTS egs inprz a GUI for the NRC RZ user codes 25 cross sections is not available in the GUI This wizard tab is already overloaded and will be split in individual tabs for photon and electron positron inputs in future releases Last edited 2011 05 09 20 49 18 5 INPUT BLOCKS DESCRIPTION AND SCREENSHOTS page 26 NRCC Report PIRS 801 5 8 The Transport Parameters by Regions Tab For some applications it might be desirable to have some of the quantities defined on a region by region basis This can be done by checking the corresponding check box or radio button of the quantity chosen in the Transport Parameter tab As soon as the user selects a quantity to be set by region this tab is enabled Here are tables for each of the quantities than can be set up on a region by region basis Tables will only be enabled for those quantities selected in the previous tab Yd dezrznrc template egsinp GUI for RZ EGSnrc user codes Copyright 2011 NRC Canada General 1 0 control Monte Carlo Geometry Source Transport Parameter Transport Parameters by Region g g m PCUT by regions ECL by regions m SMAX by regions PCUT start stop E EcuT start stop E SMAX start stop E 1 1 1
16. cts in the simulation like Compton binding effects spin effects Rayleigh scattering atomic relaxations and angular sampling of the photo electrons For a detailed reading on the physics of the transport of photons and electrons the user is refered to the EGSnre system manual NRCC Report PIRS 701 3 dosrznre_template egsinp GUI for RZ EGSnre user codes Copyright 2011 NRC Canada General 1 0 control Monte Carlo Geometry Source Transport Parameter Pair angular sampling r Electron step algorithm Global ECUT Global SMAX Global PCUT Simple J PRESTA U E E bz jJ Brems angular sampling r Electron impact ionization L Set ECUT by regions Set SMAX by regions Set PCUT by regions si MA KM off ESTEPE r Photon cross section 3 m Brems cross sections r Boundary crossing algorithm BH EXACT d 2 J Photon cross sections output m Bound Compton off r Rayleigh scattering Off r PE angular sampling off r Atomic relaxations On Execute PreviewRZ Print Compile Save Exit Help JI About Figure 14 Monte Carlo Transport Parameter Input for the RZ EGSnrc User Codes This tab has been updated to most of the latest additions to the MC trasport parameters input block Notably one
17. e and remain disabled when one selects a different user code The active file name is always displayed on the GUI s caption This can be useful to recognize whether the current file name in the input box is the same as the active one Note that the bottom row of buttons are available with all tabs 5 INPUT BLOCKS DESCRIPTION AND SCREENSHOTS egs inprz a GUI for the NRC RZ user codes 15 5 1 The General Information Tab As its name suggests this section of the tabbed dialog is intended to collect general infor mation not contemplated inside the input file itself like the input and pegs4 data file names the areas to search for those files compilation mode execution mode and its parameters the user code name etc The title constitutes an exception since it is part of the input file but does not fit in any of the different input blocks A very useful feature in this GUI is the ability to set the location of the input and pegs4 files automatically to be in the HEN HOUSE or EGS HOME area This saves time by not having to browse all the way to the location of different files acting like a shortcut If the files are loaded from a location different than the above mentioned the Other radio button is checked Note that upon loading an input file from a location other than the HEN HOUSE or EGS HOME user code area it will be only saved on the EGS HOME user code area P dosrznrc_template cgsinp GUI for RZ EGSnrc user codes Copyrig
18. es After all necessary information has been entered and stored one can execute the EGSnrc RZ user code from within the GUI by pressing the Execute button on the lower left corner of the GUI see figure 5Jin section 5 1 A dialog appears where one can define the different execution parameters see figure 3 There are two modes for running an EGSnrc RZ user code interactive or batch i e using a batch queuing system The execution mode defaults to interactive The batch execution mode is only available on Unix Linux since it has not been implemented on Windows yet At NRC the PBS batch system is currently used to send jobs to a queue where they are remotely executed returning the results after completion to the user EGSnrc area On Unix Linux if the batch execution mode is selected a pane becomes enabled where queue input parameters can be entered such as the queueing system type of queue and number of jobs to submit see figure l4 The GUI recognizes which queueing systems are available by looking up on HEN HOUSE scripts for batch definition files in the form batch options queueing system where queueing system stands for either at nqs or pbs The user can add any other batch submission system by creating a batch definition file in a similar fashion to the ones in the EGSnrcMP distribution The default batch submission system assumed in the GUI is the standard Unix job sub mission tool at The batch definition files provided in the directo
19. getting hands on experience with the EGSnrc user codes This GUI was developed using Qt a multi platform C Graphical User Interfaces toolkit that enables building efficient portable and maintainable GUI applications quickly and easily Qt is a fully object oriented easily extensible C application framework that enables rapid building of state of the art GUI applications For more information please see http www qt io Last edited 2011 05 09 20 49 18 1 INTRODUCTION page 6 NRCC Report PIRS 801 2 Installation This GUI is part of the multi platform version 2 of the EGSnrc Monte Carlo simulation system 3 For its development we used the Qt library and therefore users wanting to build it will have to install this library Most Linux distributions include the Qt library these days since the popular Desktop Environment KDE is based on this library However if the Qt library is not available in the user s system one needs to install it first Only Linux Unix users need to built this GUI since it is distributed as a binary executable on Windows We might start distributing binary executables for Linux Unix as well in the near future The only requirement for this to happen is that most Linux distributions and Unixes are binary compatible and the GUI is linked statically to the Qt library 2 1 Building egs inprz The user can have this and the other GUI s built during installation of the EGSnrc system provided QTDIR is pr
20. h for this medium in the pegs4 data file P cavrznrc template egsinp GUI for RZ EGSnrc user codes Copyright 2011 NRC Canada General 1 O control Monte Carlo Geometry Cavity Source Transport Parameter m Cavity input chamber type Wall thickness or o Z o e Es thimble Cavity radius 1 0 parallel plate Cavity length 2 0 Electrode radius 0 01 Wall material 170c5211cRU T Electrode material AL5211CRU a Execute J PreviewRZ Print Compile Save Exit Help About Figure 9 Cavity Input for the RZ EGSnrc User Code CAVRZnrc Last edited 2011 05 09 20 49 18 5 INPUT BLOCKS DESCRIPTION AND SCREENSHOTS page 20 NRCC Report PIRS 801 5 6 The Source Tab Any input related to the initial characteristics of the beam or phase space file are entered here There are 15 different types of source geometries that can be entered A detailed description of each source can be found in the NRC User Codes Manual NRCC report PIRS 702 1 and directly through the Tool Tips help feature offered by this GUI id dosrznre_template cgsinp GUI for RZ EGSnre user codes Copyright 2011 NRC Canada General uo control Monte Carlo Geometry Source Transport Parameter Incident particle source number z2 f O electron PHASE SPACE DATA INCIDENT FROM ANY ANGLE phot dris IMODE No ZLA
21. ht 2011 NRC Canada General 1 0 control Monte Carlo Geometry Source Transport Parameter Title 80 characters maximum dosrznrc template depth dose in H20 due to Cobalt beam r Select EGSnrc user code p Target User code area Pegs data area CAVRZnrc optimization EGS HOME EGS_HOME DOSRZnrc no optimization HEN HOUSE HEN HOUSE SPRRZnrc debug Other Other FLURZnrc clean r EGSnrc input file name egsinp dosrznrc_template egsinp m PEGSA file name pegs4dat 521icru pegsadat r Configuration file gnu a conf Configuration Execute if PreviewRZ Print Compile Save Exit J Help About Figure 5 General Input for the RZ EGSnrc User Codes Last edited 2011 05 09 20 49 18 5 INPUT BLOCKS DESCRIPTION AND SCREENSHOTS page 16 NRCC Report PIRS 801 5 2 The I O Control Tab This block contains information relevant to the I O controls of the NRC user codes Many of the inputs are common to all codes but there are some which are specific to only some of them d dosrznre_template egsinp GUI for RZ EGSnre user codes Copyright 2011 NRC Canada General O control Monte Carlo Geometry Source Transport Parameter r Store initial random numbers output options material summary electron transport
22. ipt which had been previously used at NRC only on Unix Linux Last edited 2011 05 09 20 49 18 3 USING EGS_INPRZ page 10 NRCC Report PIRS 801 We have now successfully used previewRZ on Windows 2000 XP after downloading and installing a Tcl Tk self extracting distribution To find out whether Tcl Tk is available on the user s system egs inprz tries to find the binary executable wish exe on Windows or wish on Unix Linux in any of the locations defined on the user s PATH environment variable The Tcl Tk package is FREELY distributed for HP UX Linux Solaris and Windows by ActiveState Corp To obtain Tcl Tk go to http www activestate com Products ActiveT cl and click on the Download link of the page For more information and useful links on Tcl Tk please visit http www tcl tk software tcltk Future versions of the egs inprz GUI will use its own previewing tool but for now users wishing to have the feature of looking at the geometry they are defining will have to install the Tcl Tk package 3 6 Printing egsinp input files To produce a hard copy of the input file users have the option to print the file by pressing the Print button located in the button group on the lower left corner of the GUI see any GUI snapshot in section 5 A Print Dialog pops up with a list of available printers and a printer and paper format setup among other options see figure 2 P Setup Printer Print destination Print to printer
23. me EXTOMeVe EXlOMeVe egsphspl Open File type cmo j P Figure 11 Phase space open file dialog 5 6 1 Setting up a BEAM Source Alternatively to phase space files EGSnrc can now use a BEAMnrc simulation as a particle source figure 12 This source source 23 needs to be set up in a separate dialog When the user selects this source a button appears with a red text prompting the user to enter the source parameters and warning that unless there are BEAM user codes compiled as a library on the system no BEAM user code will be available Clicking on the above mentioned button brings a new dialog figure 13 where the user can enter the name of the BEAM user code the BEAM input file and the required PEGSA data file based on the current PEGS4 directory The user can also define a weight window for the particles and the positioning and orientation of the source Last edited 2011 05 09 20 49 18 5 INPUT BLOCKS DESCRIPTION AND SCREENSHOTS page 22 NRCC Report PIRS 801 d dosrznrc_template cgsinp GUI for RZ EGSnrc user codes Copyright 2011 NRC Canada General uo control Monte Carlo Geometry Source Transport Parameter source number m BEAM TREATMENT HEAD SIMULATION Click on the button below to enter source information Make sure that a BEAM source has been built as a library or the combo boxes will appear empty on the input dialog See PIRS 702 and the BEAM manual for info
24. n the current directory is offered to the user through the EGSnrc input file name combo box By default the input file template dosrznrc template egsinp distributed with the EGSnrc system is loaded Alternatively the user can click on the button to the right of the combo box to invoke an open file dialog to open any egsinp file located anywhere The GUI verifies that all media used in the input file are available in the selected PEGS4 data set By default this file is set to be 521icru pegs4dat a standard data file that comes with the EGSnrc distribution If any medium is not found in the current PEGS4 data file an error message pops up recommending that the user corrects the media names and or find the appropriate data file The user code area is the location where egs_inprz will look for input files Initially egs inprz assumes that the user code area is EGS HOME user code where user code is by default dosrznrc If the GUI is started from any user code location user code is changed to the corresponding user code If a valid input file name is passed as argument to egs inprz then after identifying the user code user code is updated properly The user code area can be later changed by the user in the general input tab see figure 5 in section 5 1 Similarly the PEGS4 data area is the location where egs inprz will look for PEGS4 data sets Since there are some data sets in the EGSnrc distribution we chose to set this area to be in HE
25. napshots of each of the input blocks are provided This code is distributed under the GNU Affero General Public License 3 0 Contents 1 Introduction 4 2 Installation T 5 6 og Pde Bite dw ea as Be ee ee ee ee Se ee 6 ee ee ee eee ee 6 0 309 3 00 eee a RNUN TERRE RR EUR 7 Fe 7 3 5 Viewing the geometry with previewRZ 008 8 3 6 Printing egsinp input files 633x034 8444 48 4444484424445 9 Pe ied GR Be PE we WEE ce ae OH ES 10 ew hoe wo oe ee ee Sad we UEM Eu NIMES 10 4 Getting help 13 13 5 1 The General Information Tab 2 2 202 64 noe ba ae Rx ee 14 5 2 The I O Control Tab 5 db eee ee ee SOS UU eh Se Fee Rae S 15 5 3 The Monte Carlo Parameter Tab rs 16 54 The Geom try Tab keen O4 oe pe E eR COE aco wur arde eee ees 17 hw Th Cavity TaD e a dg ene Wa 8 oe be ewe Be Pe we Se 18 5 6 The So rce Tab es oo Ba be Bae eo 3 e oA uius esu Soho se afe us 19 Last edited 2011 05 09 20 49 18 CONTENTS page 4 NRCC Report PIRS 801 5 6 1 Setting up a BEAM Source ova oe tv e Ru Rea UE UR Ae e 20 5 7 The Transport Parameters Tab 2e 23 5 8 The Transport Parameters by Regions Tab aa 25 5 9 The Variance Reduction Tab oo Gee SG ek eo eo ee 3 26 5 10 The Plot Control Tab y aud eS ESS Oe eee Oe Meg OY s 27 30 CONTENTS egs inprz a GUI for the NRC RZ user codes 5 1 Introduction One of the major improvements in the RZ user code
26. operly set At any time the user can go to HEN HOUSE gui egs inprz and type make EGS CONFIG desired config A C compiler will have to be installed on your computer in order to build the GUIs On Windows one must have installed either MS C 6 0 or Borland C Note You only need to pass EGS CONFIG to make if it is not set or you want need to build the GUI for a different configuration as the current one In principle all Makefiles provided in the new EGSnrcMP environment are for GNU make Although they might also work with other Unix make versions It is important that the environment variable QTDIR points to the location where Qt was installed This can be checked by issuing the command echo QTDIR on Unix Linux or echo ZQTDIR on a Windows console One can change this environment variable by issuing the command setenv QTDIR Qt location for the C shell or export QTDIR Qt location for Bash or set QTDIR Qt_location on a Windows console On Unix Linux this variable can be set on a system wide basis by including the corre sponding statement above in the cshrc resource file for the C shell or the basrc resource file for Bash On Windows the user can also set the QTDIR environment variable system wide by right clicking on the My Computer icon selecting Properties and clicking on the Environment Variables button in the Advanced tab 2 INSTALLATION egs inprz a GUI for the NRC RZ user codes 7 3 Using egs_inprz
27. ry HEN HOUSE scripts contain specific definitions for the at NQS and PBS batch submission systems If the user wants to make NQS PBS or any other system the default job submission system he she can define the environment variable EGS BATCH SYSTEM to be nqs pbs or the name of the other queueing system These are the batch definition files distributed with the EGSnrc system batch options at batch options nqs batch options pbs Last edited 2011 05 09 20 49 18 3 USING EGS_INPRZ page 12 NRCC Report PIRS 801 9 Execution Setup r Input file name to run dosrznrc template egsinp m Execution mode batch NN tJ Figure 3 Execution Setup Dialog Queue names are installation especific and at NRC the names short medium and long have been adopted for PBS and NQS To change these edit the names in the proper batch definition file For more information on the implementation of parallel runs in the new EGSnrc system the reader is refered to the NRCC report PIRS 877 3 USING EGS_INPRZ egs inprz a GUI for the NRC RZ user codes 13 9 Execution Setup Input file name to run dosrznrc template egsinp Execution mode interactive batch Batch run amp of jobs Queueing system Queue Figure 4 Execution Setup Dialog in batch mode Last edited 2011 05 09 20 49 18 3 USING EGS_INPRZ page 14 NRCC Report PIRS 801 4 Getting help One of
28. s was moving from an input format based on a long series of numbers to a text based input which is easier to use This text based system for input files was then used to create a single routine get_inputs to read inputs entries for all the user codes so that now one can cut and paste entire input blocks from one user code to another This routine is now part of the EGSnrc system and can be used in any user code to parse through key value pairs in an input file As a consecuence input files look very similar and more importantly they are much easier to read and know exactly what the simulation is about without having the description of the inputs open on the desk The idea behind using a GUI for working with EGSnrc input files is to further extend the above mentioned improvements Although the input files are currently very readable one must still remember what the keys used in an input file mean By using this GUI a user can immediately get a description about any input parameter by means of tool tips egs_inprz is a Graphical User Interface GUI originally created for manipulating read ing creating modifying printing and visualizing input files for the RZ suite of EGSnrc user codes DOSRZnrc CAVRZnrc SPRRZnre and FLURZnrc see NRCC report PIRS 702 H Furthermore it can be also used for compiling and executing these user codes egs inprz is user friendly offering more flexibility on line help and therefore increases the efficiency in
29. t 0 0000 fi Random Number Initialization f FEREEFEM Execute PreviewRZ Print JI Compile Save J Exit Help J About Figure 7 Monte Carlo parameters for the RZ EGSnrc User Codes Last edited 2011 05 09 20 49 18 5 INPUT BLOCKS DESCRIPTION AND SCREENSHOTS page 18 NRCC Report PIRS 801 5 4 The Geometry Tab This input block contains all the necessary inputs for defining a RZ geometry cylindrical symmetry and the media present in the different regions It is important to notice that for the user code CAVRZnrc an option is available to define the geometry in a simpler way If the input method selected upper left corner of the tab is cavity description then the rest of the input fields in this tab are disabled and the whole geometry input occurs through the next tab the cavity tab Only media present in the current PEGSA data set can be set in the media table This is assured by activating a combo box in the first column of the media table as soon as the user tries to type or double click on it d dosrznrc template egsinp GUI for RZ EGSnrc user codes Copyright 2011 NRC Canada 9 pyrig General 1 0 control Monte Carlo Geometry Source Transport Parameter r input method 2 of front face Media input groups individual 63 description by planes
30. t for EGSnrc Technical Report PIRS 877 National Research Council of Canada Ottawa Canada 2003 3 I Kawrakow E Mainegra Hing D W O Rogers F Tessier and B R B Walters The EGSnrc Code System Monte Carlo simulation of electron and photon transport Tech nical Report PIRS 701 5th printing National Research Council of Canada Ottawa Canada 2009 Index egsinp 7 Tcl Tk 9 Trolltech Active State Corp 9 batch runs batch options wish 9 building egs inprz user code area compiling egs inprz default input file EGS BATCH SYSTEM EGS HOME EGSnrcMP executing 6 Unix Linux l6 Windows 6 geometry visualizing HEN HOUSE 6 input files creating 7 location porting 7 previewRZ printing P reading 6 installation KDE PEGSA pegs4 media PEGS4 data area previewRZ Qt INSTALL file Qt library QTDIR queueing system RZ user codes 3l
Download Pdf Manuals
Related Search