Upgrading your GEANT4 Installation

Transcription

1 your GEANT4 Installation Michael H. Kelsey SLAC National Accelerator Laboratory GEANT4 Tutorial, Jefferson Lab 13 Jul 2012

2 Where Are Upgrades? Michael H. Kelsey GEANT4 July

3 Topics of Interest Releases Major vs. Minor Patch Releases Beta Releases Reading the Release Notes Supported Platforms CLHEP Version User Code Migrations Physics and Performance Upgrade Procedure Unpack and Configure Build and Install Rebuild Applications Michael H. Kelsey GEANT4 July

4 GEANT4 Release Numbering Of the form X.Y[.pZ] or X.Y[.BetaW] X is the major release number Y is the minor release number Z is used with patch (bug-fix) releases W is used with beta (advance) releases Release 9.5 is a Minor release Release 10.0 will be the next Major release Michael H. Kelsey GEANT4 July

5 Major vs. Minor Releases Minor releases will not break user code Moving from 9.4 to 9.5, you should not need to change any application code You will likely get slightly different results You may have access to additional new features Nothing in your code should break as a result of upgrade Major releases may (usually will) break user code For example, moving from release 9.5 to 10.0, you may need to modify application code Release notes will explain all required changes Michael H. Kelsey GEANT4 July

6 Patch Releases (p01, p02,...) Corrects bugs in a regular release = No new features Release number suffix, e.g., Geant4.9.4.p04 Always advisable to install latest patch Patch release notes will describe exactly what has changed Decide whether upgrade is really required Michael H. Kelsey GEANT4 July

7 Beta Releases (Beta1, Beta2,...) Introduces new features before they have been deemed sufficiently tested for general users Opportunity for user testing of many (not all) changes intended for December release Release number suffix, e.g., Geant4.9.6.Beta1 Not intended for general users Willing to take risks inherent in beta testing Move only if you really love testing things Geant4 collaborator reports specific problem fix Michael H. Kelsey GEANT4 July

8 Release Notes Detailed description with release Linked from download Web page Included in distribution Sections 1, 2, 3 and 5 most useful Supported platforms, compilers CLHEP version (if external) User-code migration items Physics, performance effects Michael H. Kelsey GEANT4 July

9 Release Notes: Platforms and Compilers May change at Major or Minor release If no longer supported, either upgrade or try with what you have Geant4 still builds and starts OK? = No problem Problems with build or startup? = Upgrade to a supported platform = Upgrade specific libraries/pdks Michael H. Kelsey GEANT4 July

10 Release Notes: Platforms and Compilers 1. Supported and Tested Platforms Officially tested platforms: Linux, gcc and gcc (SLC5). Tested on 32 and 64 bit architectures (Intel or AMD) with Scientific Linux CERN 5 (SLC5) (based on RedHat Linux Enterprise 5). MacOSX 10.7 with gcc Windows7 with Visual C (Visual Studio 2010) More verified configurations: Linux, gcc Linux, Intel-icc 11.1, 12.0 MacOSX 10.6 with gcc Windows/XP with Visual C (Visual Studio 2008) Michael H. Kelsey GEANT4 July

11 Release Notes: Migration Listed here is some relevant information on developments included in this release, some of which may require migrations (mainly for users of advanced Geant4 features) in order to upgrade from release 9.x to release 9.y. Note that for all users a full re-installation of libraries (or a full recompilation) and a recompilation of user applications is required. Minor releases generally Introduce new features Without eliminating existing functionality Obsolete features usually carry a warning message, before being removed Major releases May change inheritance requirements Remove or alter public function signatures Provide substantially new features or performance Michael H. Kelsey GEANT4 July

12 Release Notes: Performance and Physics Reports what to expect from applications Changed results (based on release benchmark tests) Differences in running time or memory allocation Configuration required for access to new features Standard Electromagnetic physics A new tune of the Urban multiple-scattering model for electrons is provided. Is is named G4UrbanMscModel95. This features higher accuracy of electron scattering and stability of energy deposition when the step size is varied. The model is currently set as the default for electrons and positrons. A new model for Bremsstrahlung, G4SeltzerBergerModel, is now used by default at energies below 1 GeV. The model is based on tabulated cross-sections published by S.M. Seltzer and M.J. Berger. It provides agreement with the low energy Livermore and Penelope models below 10 MeV and the standard relativistic model at 1 GeV, improving the most over the previous standard Bremsstrahlung model in the energy range from 1 kev to 1 GeV. Michael H. Kelsey GEANT4 July

13 Prepare to Upgrade Check Release Notes to ensure local system is supported, upgrade if necessary Ensure application code is not in GEANT4 release area $G4WORKDIR should not be a subdirectory of $G4INSTALL Good practice: /some/path/geant4/geant4.9.5/... ($G4INSTALL) /g4work/myusercode ($G4WORKDIR) Bad practice: /some/path/geant4/geant4.9.5/... /some/path/geant4/geant4.9.5/myusercode Michael H. Kelsey GEANT4 July

14 Why Separate Applications Area? Applications can/should work with several different GEANT4 versions Should not have to copy stable code from release to release Can delete old releases without accidentally deleting applications Can distribute applications to colleagues separately from GEANT4 Michael H. Kelsey GEANT4 July

15 How to Upgrade Unpack new Geant4 version For example, to: /mydir/geant4/geant4.9.5/... Make sure you do not have any left over G4 environment variables printenv grep G4 Start new session, clean up.login or.cshrc, or whatever is necessary Configure: cmake -D... From geant4-build directory Build: make -jn (N = number of cores) Move to installation area: make install Michael H. Kelsey GEANT4 July

16 How to Upgrade Clean up the old compilation products of user code Delete bin, lib and tmp from $G4WORKDIR These contain user code linked against old Geant4 release Removal ensures that new build is complete, selfconsistent Run make -f Makefile from application directory Michael H. Kelsey GEANT4 July

17 In Case of Trouble Did you review the Release Notes? Did you remove all pre-existing G4 environment variables? = May be pointing to mix of old and new releases Did you delete old bin, lib and tmp directories from $G4WORKDIR? = May have some code compiled against one Geant4 release and some compiled against another Check the Geant4 Installation and Configuration Forum Michael H. Kelsey GEANT4 July

18 Discussion Forum Good search function at top of page Someone might have had same issue Solution may already be posted If problem is new, please post it! Collaboration members and expert users/developers contribute Michael H. Kelsey GEANT4 July