Merge pull request #716 from kochebina/Gate9.5

For Gate 9.4.1 release

Author: kochebina

.github/workflows/main.yml

@@ -24,8 +24,8 @@ jobs:
 
     env:
       ROOT_VERSION: 'v6-32-02'
-      GEANT4_VERSION: 'v11.2.1'
       ITK_VERSION: 'v5.4.2'
+      GEANT4_VERSION: 'v11.3.0'
       ROOT_DIR: $(HOME)/software/root
       GEANT4_DIR: $(HOME)/software/geant4
 
@@ -338,5 +338,5 @@ jobs:
         mkdir gate_benchmarks
         export GIT_SSL_NO_VERIFY=1
         git clone --recursive https://github.com/OpenGATE/GateBenchmarks.git gate_benchmarks
-        docker run --rm -e "TEST=${{ matrix.strategy_name }}" -v $GITHUB_WORKSPACE:/src -v $GITHUB_WORKSPACE/gate_benchmarks:/home tbaudier/gatebenchmarks:9.4 /home/.github/workflows/runTest.sh
+        docker run --rm -e "TEST=${{ matrix.strategy_name }}" -v $GITHUB_WORKSPACE:/src -v $GITHUB_WORKSPACE/gate_benchmarks:/home tbaudier/gatebenchmarks:9.4.1 /home/.github/workflows/runTest.sh
 

CMakeLists.txt

@@ -312,14 +312,13 @@ MESSAGE("Your current Geant4 version is ${Geant4_VERSION}")
 
 #=========================================================
 # Display message about this version
-MESSAGE("IMPORTANT! This version of GATE (9.4) has still some traces of passage for new digitizer.")
+MESSAGE("IMPORTANT! This version of GATE (9.4.1) has still some traces of passage for new digitizer.")
 MESSAGE("Please, be aware that some of functionalities are NOT YET re-implemented: ")
-MESSAGE("- Coincidence digitizer modules (combining of several Coincidence Sorters)")
 MESSAGE("- Output: Sinogram, Ecat7, LMF")
 MESSAGE("- ARF may work not properly yet")
 MESSAGE("We apologize for this inconvenience and kindly ask for your patience.")
-MESSAGE("This functionalities will be added during 2024.")
-MESSAGE("Meanwhile, please, use Gate 9.3")
+MESSAGE("This functionalities will be added during 2025.")
+MESSAGE("Meanwhile, please, use Gate 9.4")
 
 
 

Gate.cc

@@ -158,7 +158,7 @@ void welcome()
 {
   GateMessage("Core", 0, G4endl);
   GateMessage("Core", 0, "*******************************************************" << G4endl);
-  GateMessage("Core", 0, " GATE version 9.4 (2024)" << G4endl);
+  GateMessage("Core", 0, " GATE version 9.4.1 (2025)" << G4endl);
   GateMessage("Core", 0, " Copyright : OpenGATE Collaboration" << G4endl);
   GateMessage("Core", 0, " Reference : Phys. Med. Biol. 49(19) 4543-4561     2004 " << G4endl);
   GateMessage("Core", 0, " Reference : Phys. Med. Biol. 56(4)  881-901       2011 " << G4endl);
@@ -256,7 +256,7 @@ int main( int argc, char* argv[] )
           break;
         case 'v':
           ss << G4VERSION_MAJOR << "." << G4VERSION_MINOR << "." << G4VERSION_PATCH;
-          std::cout << "Gate version is 9.4 ; Geant4 version is " << ss.str() << std::endl;
+          std::cout << "Gate version is 9.4.1; Geant4 version is " << ss.str() << std::endl;
           exit(0);
           break;
         case 'a':

readme.md

@@ -15,7 +15,7 @@ More details : http://www.opengatecollaboration.org
 
 Documentation : https://opengate.readthedocs.io
 
-* The stable version is tag 9.4: https://github.com/OpenGATE/Gate/tree/v9.4 with Geant4 11.2.1
+* The stable version is tag 9.4.1: https://github.com/OpenGATE/Gate/tree/v9.4.1 with Geant4 11.3.0
 * The current development version is branch 'develop' (default): http://github.com/OpenGATE/Gate/tree/develop
 * [Benchmarks](https://github.com/OpenGATE/GateBenchmarks)
 * [Examples](https://github.com/OpenGATE/GateContrib)

release_notes/v9.4.1.txt

@@ -0,0 +1,57 @@
+#  *ooooOOOO0000OOOOoooo*  #
+#                          #
+#       GATE v9.4.1        #
+#                          #
+#        02/2025           #
+#                          #
+#  *ooooOOOO0000OOOOoooo*  #
+
+
+This version is intended to be used with Geant4 11.3.0 only. 
+Gate cannot be compiled with earlier Geant4 versions. 
+It *may* works with other ROOT, ITK, libtorch version but it is not tested.
+
+Dependencies:
+- Geant4: v11.3.0 (cxx17 is required)
+- ROOT: v6-32-08 (must be compiled with -DCMAKE_CXX_STANDARD=17)
+- ITK: v5.2.0 (with RTK enabled)
+- libtorch: v1.10.1
+
+
+-----------------
+Main new features
+-----------------
+
+- Bug corrections:
+1) Coincidence Sorter: Remove "keep" options in multiple policy PR #703
+2) Init value for Energy Resolution module PR #699
+3) Coincidence Sorter: Option for removal of oblique coincidences (setDeltaZMax)  #700
+
+From 9.4 version: 
+1) Some of functionalities are temporarily disabled:
+          - Outputs: Sino, LMF, Ecat7
+
+New features:
+1) Option to save Hits from several sensitive detectors in the same ROOT tree
+2) Generalisation of Spatial resolution (x,sigma(x))
+3) Coincidence digitizers added (Multiples Killer, Buffer, Time Difference)
+4) New Digitizer Module : Virtal Segmentation (for Monolithic crystal)
+5) 
+
+
+- additional Benchmarks
+https://github.com/OpenGATE/GateBenchmarks
+
+----------
+Gate Tools
+----------
+
+-------------
+Documentation
+-------------
+
+GATE home page:	    http://www.opengatecollaboration.org
+GATE documentation: https://opengate.readthedocs.io
+GATE examples:      https://github.com/OpenGATE/GateContrib
+GATE benchmarks:    https://github.com/OpenGATE/GateBenchmarks
+GATE tools:         https://github.com/OpenGATE/GateTools

source/docker/Generate-9.4.1.sh

@@ -0,0 +1,23 @@
+#!/bin/sh
+
+#Variables to modify
+Repository=opengatecollaboration
+ROOT_Version=v6-24-06
+CLHEP_Version=2.4.6.0
+Geant4_Version=11.3.0
+Gate_Version=9.4.1
+
+#Variables to preserve
+Geant4_Tag=$Repository/geant4:$Geant4_Version
+Gate_Tag=$Repository/gate:$Gate_Version-docker
+
+docker build -t $Geant4_Tag -f DockerFileGeant \
+    --build-arg ROOT_Version=$ROOT_Version \
+    --build-arg CLHEP_Version=$CLHEP_Version \
+    --build-arg Geant4_Version=v$Geant4_Version .
+#docker push $Geant4_Tag
+#
+#docker build -t $Gate_Tag -f DockerFileGate \
+#    --build-arg Geant4_Version=$Geant4_Tag \
+#    --build-arg Gate_Version=v$Gate_Version .
+#docker push $Gate_Tag

source/docker/README.md

@@ -10,15 +10,15 @@ login: `docker login`
 
 [build and use]
 * build: 
-    * `docker build -t opengatecollaboration/geant4:11.2.1 -f DockerFileGeant --build-arg ROOT_Version=v6-24-06 --build-arg Geant4_Version=v11.2.1 .`
+    * `docker build -t opengatecollaboration/geant4:11.3.0 -f DockerFileGeant --build-arg ROOT_Version=v6-24-06 --build-arg Geant4_Version=v11.3.0 .`
 * push: 
     * `docker push opengatecollaboration/geant4:$version`
 * interactive: 
     * `docker run -it --rm -v $PWD:/APP opengatecollaboration/geant4:$version /bin/bash`
 
 Where: 
 
-* `$version` is `11.2.1` for gate `9.4`
+* `$version` is `11.3.0` for gate `9.4.1`
 
 # Second image Gate
 ## Docker for gate
@@ -29,7 +29,7 @@ login: `docker login`
 
 [build and use]
 * build: 
-    * `docker build -t opengatecollaboration/gate:9.4 -f DockerFileGate --build-arg Geant4_Version=opengatecollaboration/geant4:11.2.1 --build-arg Gate_Version=v9.4 .`
+    * `docker build -t opengatecollaboration/gate:9.4.1 -f DockerFileGate --build-arg Geant4_Version=opengatecollaboration/geant4:11.3.0 --build-arg Gate_Version=v9.4.1 .`
 * push:  
     * `docker push opengatecollaboration/gate:$version`
 * run command:  
@@ -41,4 +41,4 @@ You can just install docker and then create an alias in your configuration
 * ```echo "alias Gate='docker run -i --rm -v $PWD:/APP opengatecollaboration/gate:$version'" >> ~/.bashrc```
 
 Where: 
-* `$version=9.3`
+* `$version=9.4.1`

source/docker/runAll.sh

@@ -3,4 +3,5 @@
 ./Generate-8.1.sh
 ./Generate-8.2.sh
 ./Generate-9.0.sh
-./Generate-9.1.sh
+./Generate-9.1.sh
+./Generate-9.4.1.sh

source/docker/vGate.sh

@@ -69,7 +69,7 @@ make
 cd
 cd Software/Geant4
 mkdir src bin install data
-git clone -b v11.2.1 https://github.com/Geant4/geant4.git src
+git clone -b v11.3.0 https://github.com/Geant4/geant4.git src
 cd bin
 ccmake ../src -DGEANT4_INSTALL_DATA=ON -DGEANT4_BUILD_MULTITHREADED=OFF -DGEANT4_INSTALL_DATADIR=/home/vgate/Software/Geant4/data -DCMAKE_INSTALL_PREFIX=/home/vgate/Software/Geant4/install -DGEANT4_BUILD_MULTITHREADED=OFF -DGEANT4_USE_QT=ON -DGEANT4_USE_OPENGL_X11=ON
 make install
@@ -101,7 +101,7 @@ echo 'source /home/vgate/Software/Geant4/install/bin/geant4.sh' >> /home/vgate/.
 cd
 cd Software/Gate
 mkdir src bin
-git clone -b v9.4 https://github.com/OpenGATE/Gate.git src
+git clone -b v9.4.1 https://github.com/OpenGATE/Gate.git src
 cd bin
 ccmake ../src -DGATE_USE_RTK=ON -DGATE_USE_TORCH=ON -DTorch_DIR=/home/vgate/Software/libtorch/share/cmake/Torch -DGATE_COMPILE_GATEDIGIT=ON
 make