Skip to content
Snippets Groups Projects
ReleaseNotes.md 260 KiB
Newer Older
# v01-27-01

* 2023-11-20 jmcarcell ([PR#1191](https://github.com/aidasoft/DD4hep/pull/1191))
  - CMake: Add a check for the c++ standard that Geant4 was compiled with, and fail if it is
    different from the one required for DD4hep.

* 2023-11-19 Wouter Deconinck ([PR#1190](https://github.com/aidasoft/DD4hep/pull/1190))
  - Use TROOT::GetIconPath to find icons in DDEve

* 2023-11-17 Markus Frank ([PR#1187](https://github.com/aidasoft/DD4hep/pull/1187))
  - Implement startup flags to set the visualization depth in teveDisplay like for geoDisplay.
    See  Issue: See deeper hierarchy in teveDisplay  https://github.com/AIDASoft/DD4hep/issues/1186 for details.

* 2023-11-17 Dmitry Kalinkin ([PR#1184](https://github.com/aidasoft/DD4hep/pull/1184))
  - Fixed runtime issues during initialization caused by incorrectly placed `DECLARE_SEGMENTATION` for CartesianGridXYStaggered and HexGrid.

# v01-27

* 2023-10-19 Alvaro Tolosa Delgado ([PR#1174](https://github.com/aidasoft/dd4hep/pull/1174))
  - Geant4OpticalTracker: Kill optical photons (instead of all other particles) as soon they enter into a Optical Tracker sensitive detector

* 2023-10-19 Wouter Deconinck ([PR#1148](https://github.com/aidasoft/dd4hep/pull/1148))
  - Allow several DDRec c'tors to work on `const Detector&` instead of `Detector&`

* 2023-10-18 Markus Frank ([PR#1181](https://github.com/aidasoft/dd4hep/pull/1181))
  Allow for XML processing of files relative to xml tag location:
  - For some tags the relative placement of include files was not possible.
    This pull request is supposed to close these missing include features.
  - See issue https://github.com/AIDASoft/DD4hep/issues/1180 for details)
  - See the examples ClientTests: minitel_config_plugins_include_command_xml
    with the compact file ClientTests/compact/IncludePlugins.xml for an example.

* 2023-10-17 Alvaro Tolosa Delgado ([PR#1179](https://github.com/aidasoft/dd4hep/pull/1179))
  - DDSim: Corrected documentation of `--gun.energy`. This corresponds to the total energy including the mass of the particle

* 2023-10-11 Andre Sailer ([PR#1176](https://github.com/aidasoft/dd4hep/pull/1176))
  - DDG4: G4VTouchable: for Geant4 11.1.ref09 cannot forward declare the class any more

* 2023-10-11 Markus Frank ([PR#1175](https://github.com/aidasoft/dd4hep/pull/1175))
  - Handle request from issue 1166: Allow to load CAD files with relative path w/r to declaring xml file 
  - Add illustrating example: t_DDCAD_Check_Shape_RelativePath

* 2023-09-20 Dhevan Gangadharan ([PR#1170](https://github.com/aidasoft/dd4hep/pull/1170))
  - Extend usage of dumpBfield to asymmetric X,Y,Z ranges.

* 2023-09-20 Sebouh Paul ([PR#1161](https://github.com/aidasoft/dd4hep/pull/1161))
  - DDSegmentation: added segmentation HexGrid for hexagonal segmentation
  - DDSegmentation: added CartesionGridXYStaggered for rectangular segmentation that can be staggered for every other layer

* 2023-09-19 Dmitry Kalinkin ([PR#1171](https://github.com/aidasoft/dd4hep/pull/1171))


* 2023-09-15 jmcarcell ([PR#1169](https://github.com/aidasoft/dd4hep/pull/1169))
  - CMake: DDG4: Check if the CLHEP target exists before creating it in DD4hepBuild.cmake, since if it exists cmake will error.

* 2023-09-15 Wouter Deconinck ([PR#1168](https://github.com/aidasoft/dd4hep/pull/1168))
  - ddsim: handle run header exception when the user has no username.

* 2023-08-31 Dmitry Kalinkin ([PR#1165](https://github.com/aidasoft/dd4hep/pull/1165))
  - DDG4: HepMC3Input: Fix loading of run info for RootTree HepMC3 input format

* 2023-08-25 Andre Sailer ([PR#1162](https://github.com/aidasoft/dd4hep/pull/1162))
  - DDEve Webdisplay: fix issue with ROOT master with RGeomViewer no longer being in the experimental namespace.

* 2023-08-24 Andre Sailer ([PR#1160](https://github.com/aidasoft/dd4hep/pull/1160))
  - SiliconBlockGFlash: add maximal energy for using parametrisation, for electron and positron, fixes #1153

* 2023-08-24 Markus Frank ([PR#1155](https://github.com/aidasoft/dd4hep/pull/1155))
  - Implement correct transparency handling of ROOT:
    The transparency setting was connected to the material of the volume.
    This led to the same transparency setting for all volumes of the same material.
    It was not possible to change them at the level of the volume though 
    the API  suggested so.
    See: https://github.com/AIDASoft/DD4hep/issues/1117
    See: https://github.com/root-project/root/pull/13402
  - Add test examples/ClientTests/compact/visTestEx.xml and visTest.xml.
    From the inversion of tubes with the same material, for ROOT >= 6.29
    the correct transparency settings are shown, whereas for ROOT < 6.29
    the transparency settings are the same for all volumes.
    Also see scripts/visTest.C

* 2023-08-23 Ben Couturier ([PR#1159](https://github.com/aidasoft/dd4hep/pull/1159))
  - Improved _getEnviron to deal with the case when multiple variables are to be evaluated in the string

* 2023-08-22 Dmitry Kalinkin ([PR#1158](https://github.com/aidasoft/dd4hep/pull/1158))
  - DDSim: Fix reading HepMC3 input files via xrootd, fixes #1156

* 2023-08-22 Wouter Deconinck ([PR#1157](https://github.com/aidasoft/dd4hep/pull/1157))
  - Geant4Output2EDM4hep: allow use of identical collection names across multiple detectors

* 2023-08-04 Andre Sailer ([PR#1152](https://github.com/aidasoft/dd4hep/pull/1152))
  - CI: use clang16 for header guards check

* 2023-08-04 jmcarcell ([PR#1151](https://github.com/aidasoft/dd4hep/pull/1151))
  - Limits object: fix string creation of Limit::toString, this will now also print the relevant "particles"
  - Shapes: remove "move" from return of dimensions()

# v01-26

* 2023-07-24 Andre Sailer ([PR#1147](https://github.com/aidasoft/DD4hep/pull/1147))
  - Add reading of HepMC3 run info and forwarding it to output files: fixes #1114. Reliably this will only work for HepMC3 >= 3.2.6.

* 2023-07-18 Markus Frank ([PR#1146](https://github.com/aidasoft/DD4hep/pull/1146))
  - By default do not keep hash string for detector checksum to minimize resource usage.
   As pointed out in Issue https://github.com/AIDASoft/DD4hep/issues/1143 keeping the hash string of detector
    components  is very often too resource/memory consuming. Hence keep the hashed strings only if requested
    e.g. for debugging purposes. By default the hash strings are not kept.
  This means the produces hash sums are NOT backwards compatible, because during the checksum creation the
  hash strings from sub-components were used. These are now consequently replaced by the corresponding hash codes.

* 2023-07-18 Andre Sailer ([PR#1145](https://github.com/aidasoft/DD4hep/pull/1145))
  - DDSim: ConfigHelper: prevent using unknown properties everywhere but in Meta, where we want to allow adding arbitrary information, fixes #1072

* 2023-07-17 Andre Sailer ([PR#1144](https://github.com/aidasoft/DD4hep/pull/1144))
  - DDSim: change the default output file name on how DD4hep was built. Fixes #1101 
     - Add outputConfig.forceLCIO, outputConfig.forceEDM4HEP, outputConfig.forceDD4HEP switches to force a particular output plugin
     - If LCIO was used, slcio is still the default
     - If EDM4hep was used but not LCIO, EDM4hep is the default and used for all root output files. 
     - If neither LCIO or EDM4hep was used, then DD4hep's root output is used. Use the outputConfig.forceDD4HEP flag to use DD4hep's root output if EDM4hep is available as well
  
  - DDSim: remove python2 legacy shims
  - Geant4UIManager: fail when pre or post run commands are not successfully executed.

* 2023-07-14 Andre Sailer ([PR#1142](https://github.com/aidasoft/DD4hep/pull/1142))
  - DDSim: add the possibility to configure execution of Geant4 UI commands during the different Geant4 UI phases (fixes #1010)

* 2023-07-13 Wouter Deconinck ([PR#1141](https://github.com/aidasoft/DD4hep/pull/1141))
  - Support TGeoTessellated volumes in DetectorChecksum

* 2023-07-13 tmadlener ([PR#1140](https://github.com/aidasoft/DD4hep/pull/1140))
  - Create a separate `metadata` Frame in the edm4hep output and put the `CellIDEncoding` strings there in order to follow the new convention for this introduced by key4hep/k4FWCore#100.

* 2023-06-24 Markus Frank ([PR#1139](https://github.com/aidasoft/DD4hep/pull/1139))
  - Add test for issue #1134

* 2023-06-23 tmadlener ([PR#1138](https://github.com/aidasoft/DD4hep/pull/1138))
  - Make the default return value of `DetElementCreator::process` non-zero to avoid erroneously raising an exception after finishing. 
  - Add a test case that checks that things work

* 2023-06-22 Markus Frank ([PR#1136](https://github.com/aidasoft/DD4hep/pull/1136))
  - Adds missing parts to: https://github.com/AIDASoft/DD4hep/pull/1135
  - Enable CLICSiD GDML exports and import tests and fix the broken import test.

* 2023-06-22 Andre Sailer ([PR#1133](https://github.com/aidasoft/DD4hep/pull/1133))
  - DDSim: OutputConfig: correct the example to be valid python in all cases.

* 2023-06-21 tmadlener ([PR#1132](https://github.com/aidasoft/DD4hep/pull/1132))
  - Add conversion from of `TGeoPara` to `G4Para`

* 2023-06-16 Markus Frank ([PR#1131](https://github.com/aidasoft/DD4hep/pull/1131))
  - Fix compile error on MacOS
    See issue https://github.com/AIDASoft/DD4hep/issues/1130

* 2023-06-14 Wouter Deconinck ([PR#1129](https://github.com/aidasoft/DD4hep/pull/1129))
  - fix: exit(0) when --dumpParameter/dumpSteeringFile

* 2023-06-13 Markus Frank ([PR#1128](https://github.com/aidasoft/DD4hep/pull/1128))
  - Move DDDigi edm4hep I/O to new frame writing.
  - Improve DDG4 edm4hep I/O (remove debug statements)
  - Protect DDDigi edm4hep output against races
  - Fix some compiler warnings

* 2023-06-12 Wouter Deconinck ([PR#1108](https://github.com/aidasoft/DD4hep/pull/1108))
  - Delay writing EDM4hep collections until `commit` at end of event, allowing for multiple collections with same name

* 2023-06-09 Markus Frank ([PR#1125](https://github.com/aidasoft/DD4hep/pull/1125))
  - Define the CellID and the VolumeID data types of segmentations as uint64_t rather than signed integers.
    Reasoning: Please see issue: 1090 (https://github.com/AIDASoft/DD4hep/issues/1090)

* 2023-06-09 tmadlener ([PR#1113](https://github.com/aidasoft/DD4hep/pull/1113))
  - Remove the copy&past `DigiFrame.h` and use the upstream `podio/Frame.h` as all functionality is available from there.
  - Increase the minimum podio version to 0.16.3

* 2023-06-09 tmadlener ([PR#1112](https://github.com/aidasoft/DD4hep/pull/1112))
  - Use the templated `getMap` access functionality for `podio::GenericParameters` as the non-templated versions will be removed.

* 2023-06-08 Markus Frank ([PR#1126](https://github.com/aidasoft/DD4hep/pull/1126))
  - Allow to user-set world material in compact description:
  ```
    <world material="Steel235">
    </world>
  ```
    See issue https://github.com/AIDASoft/DD4hep/issues/1116 for details.
  - Add test t_minitel_config_world_material illustrating the feature.

* 2023-06-02 tmadlener ([PR#1124](https://github.com/aidasoft/DD4hep/pull/1124))
  - DDDigi: Make the `get{Value,}TypeName` calls work with the upcoming switch to `std::string_view` return types in podio.

* 2023-06-01 Andre Sailer ([PR#1123](https://github.com/aidasoft/DD4hep/pull/1123))
  - Volumes.h: rearrange implementation of classes, fix needed for gcc13/root 6.28/04, c++20

* 2023-06-01 Juraj Smiesko ([PR#1122](https://github.com/aidasoft/DD4hep/pull/1122))
  - ddsim: fix indentation from steeringfile produced by `ddsim --dumpSteeringFile`

* 2023-06-01 Dmitry Kalinkin ([PR#1089](https://github.com/aidasoft/DD4hep/pull/1089))
  - Add optional support for reading compressed files using HepMC3. Enabled with cmake flag DD4HEP_HEPMC3_COMPRESSION_SUPPORT. Needs at least HepMC3.2.5 and presence of zlib, lzma, bzip2

* 2023-05-31 Markus Frank ([PR#1120](https://github.com/aidasoft/DD4hep/pull/1120))
  - Fix example arguments

* 2023-05-31 Dmitry Kalinkin ([PR#1106](https://github.com/aidasoft/DD4hep/pull/1106))
  - DetectorImp::getRefChild() will no longer print to error context to std::cout, it will instead appear in the message of the runtime_exception thrown.

* 2023-05-30 Markus Frank ([PR#1119](https://github.com/aidasoft/DD4hep/pull/1119))
  - Disable DDCMS Geant4 example to resolve MR chain

* 2023-05-30 Paul Gessinger ([PR#1109](https://github.com/aidasoft/DD4hep/pull/1109))
  - Remove `using namespace std;` in `Printout.cpp`

* 2023-05-30 Andre Sailer ([PR#1100](https://github.com/aidasoft/DD4hep/pull/1100))
  - CMake: increase required version of Cmake from 3.12 to 3.14

* 2023-05-30 Markus Frank ([PR#1098](https://github.com/aidasoft/DD4hep/pull/1098))
  - MiniTel Generate example should replect the detector in issue (https://github.com/AIDASoft/DD4hep/issues/1091)

* 2023-05-04 Wouter Deconinck ([PR#1105](https://github.com/aidasoft/DD4hep/pull/1105))
  - allow rotation/position transformation on entire CAD_MultiVolume

* 2023-04-26 Andre Sailer ([PR#1099](https://github.com/aidasoft/DD4hep/pull/1099))
  - thisdd4hep.sh: make the Geant4 path discovery compatible with Geant4 11.1.1

* 2023-04-25 Andre Sailer ([PR#1097](https://github.com/aidasoft/DD4hep/pull/1097))
  - Geant4InputHandling: in case the MC generator gives us a negative mass, the proper_time_precision could be negative and we would not identify properTimeZero correctly. Fixes parts of #1094 when ddg4 smearing is used.

* 2023-04-21 scott snyder ([PR#1093](https://github.com/aidasoft/DD4hep/pull/1093))
  - ddsim: Fix handling of --meta.runNumberOffset and --meta.eventNumberOffset command-line switches.

* 2023-04-21 Frank Gaede ([PR#1088](https://github.com/aidasoft/DD4hep/pull/1088))
  - fix units in `Geant4FastSimShowerModel::constructSensitives`
       - used for energy check in `Geant4FastSimShowerModel::check_trigger`  for fast simulation

* 2023-04-21 Andre Sailer ([PR#1074](https://github.com/aidasoft/DD4hep/pull/1074))
  - DDSim: add explicit configuration of the Geometry construction, exposing many debug options for elements, materials, volumes, shapes, placements, Reflections, Regions, and Surfaces. See ddsim --help or --dumpSteeringFile

* 2023-03-31 Markus Frank ([PR#1087](https://github.com/aidasoft/DD4hep/pull/1087))
  - Improve plugin information
  -  inline in StandardPlugins.cpp and ShapePlugins.cpp
  - In DD4hep manual

* 2023-03-30 Andre Sailer ([PR#1086](https://github.com/aidasoft/DD4hep/pull/1086))
  - HepMC3: use all vertex information to create primary vertices, including time, fixes #1082

* 2023-03-29 Markus Frank ([PR#1084](https://github.com/aidasoft/DD4hep/pull/1084))
  - Upgrade standard plugins. Add some help information

* 2023-03-29 Markus Frank ([PR#1083](https://github.com/aidasoft/DD4hep/pull/1083))
  - Add plugin to assign VolumIDs to DetElements
    Normally this functionality id done by the VolumeManager. However, some clients prefer to not use the volume manager.
    With this plugin this basic functionality can be maintained.
  - Update plugin DD4hep_DetectorDump to optionally output the accumulated volume identifiers when traversing 
    the DetElement tree.
  
  To test both, invoke e.g.:
  ```
  $> geoPluginRun -input ../DD4hep/DDDetectors/compact/SiD.xml \
       -plugin DD4hep_DetElementVolumeIDs -detector /world \
       -plugin DD4hep_DetectorDump -sensitive -volids
  ```

* 2023-03-23 Markus Frank ([PR#1081](https://github.com/aidasoft/DD4hep/pull/1081))
  Allow users to add track user information to G4 tracks, which then moves to Geant4Particle for saving
  Use class Geant4ParticleInformation to extend the Geant4Particle object.
  Wrapper to store any user information as a `G4VUserTrackInformation` in a `G4Track`.
      The data of type `ParticleExtension` is moved from the `G4Track` to the `Geant4Particle` in the `Geant4ParticleHandler` if present. This automatically make the `G4Track` instance persistent as a `Geant4Particle`.
  Hence: Be careful to not assign the entity by default!
  
  The data in the subclass of `ParticleExtension` defined by the user
  requires a dictionary to be stored to ROOT.
  
  - Example: examples/DDG4_MySensDet. See examples/DDG4_MySensDet/src/MyTrackerSDAction.cpp for details.
  - Great thanks to ROOT for now being able to store std::unique_ptr<T>!
  - This is sort of a sub-issue to https://github.com/AIDASoft/DD4hep/issues/1073

* 2023-03-23 Christopher Dilks ([PR#1069](https://github.com/aidasoft/DD4hep/pull/1069))
  - rename `OpticalTracker` example to `RICH`

* 2023-03-22 Markus Frank ([PR#1080](https://github.com/aidasoft/DD4hep/pull/1080))
  - Fix bug in B field component access after a space transformation of multipole fields.
    See issue  MultipoleMagnet rotation #1073 https://github.com/AIDASoft/DD4hep/issues/1073 for details.

* 2023-03-22 Markus Frank ([PR#1079](https://github.com/aidasoft/DD4hep/pull/1079))
  - Optimize sensitive detector callbacks in DDG4.
    Many operations were performed twice: once in the sensitive detector, and once again in the computation of
    the MC contribution to the hit. This MR removes multiple computations and uses the results from the MC
    contribution to create the hit.
    The change should be fully compatible and delivers numerically identical results.
  
  - Remove deprecated DetElement factories.
    To not clutter the global namespace with factory names, factories in the DDDetectors area were declared
    deprecated many years ago. At a time these factories were replaced by identical factoris with a name prefix "DD4hep_".
    These factories are "official" and should be used instead.
    On creation such factories issued a warning message.
    It is now time to remove these factories completely.

* 2023-03-21 Christopher Dilks ([PR#1065](https://github.com/aidasoft/DD4hep/pull/1065))
  - Add test for average energy deposition in `OpticalTracker` example, for `Geant4SensitiveAction<Geant4OpticalTracker>`

* 2023-03-15 Markus Frank ([PR#1078](https://github.com/aidasoft/DD4hep/pull/1078))
  - See issue 1076 https://github.com/AIDASoft/DD4hep/issues/1076

* 2023-03-15 Wouter Deconinck ([PR#1075](https://github.com/aidasoft/DD4hep/pull/1075))
  - ddsim: Support for setting etaMin and etaMax. These override the respective theta settings!

* 2023-03-03 Markus Frank ([PR#1071](https://github.com/aidasoft/DD4hep/pull/1071))
  -  Verify and enhance the possibility to import plugin definitions from an external XML file
    (See isue: https://github.com/AIDASoft/DD4hep/issues/1062).
    The corresponding examples are:
    -- minitel_config_plugins_include_command_line, which shows how to perform the task by parsing sequentially the 
       XML input files like: 
       ```
       $> geoPluginRun -input <path>/compact/MiniTel.xml  -input  <path>/compact/ExamplePlugins.xml
      ```
    -- minitel_config_plugins_include_command_xml, where the second XML file is simply included:
  
        <includes>
          <file ref=<path>/examples/ClientTests/compact/BoxTrafos.xml/>
          <file ref=<path>/examples/ClientTests/compact/ExamplePlugins.xml/>
        </includes>
     where `BoxTrafos` is the entire original XML containing the geometry.
  -  Add plugins: configure Volume/SensitiveDetector object instances from information in XML Nodes. Given an XML tag like:
     ```
      <plugin type="config" name="DD4hep_DetElementConfig" path="/world" debug="true">
        <volume>
           <regionref   name="world_region"/>
           <limitsetref name="world_limits"/>
           <visref      name="world_vis"/>
        </volume>
      </plugin>```
  Can be used directly to modify the settings of s DetElement identified by its path. Similar for sensitive detector objects:
  ```
      <plugin type="config" name="DD4hep_SensitiveDetectorConfig" detector="MyLHCBdetector5" debug="true">
        <combine_hits    value="true"/>
        <verbose         value="true"/>
        <type            value="tracker"/>
        <ecut            value="5*keV"/>
        <hits_collection value="hits_collection_5"/>
      </plugin>
  ```
  - This construct also allows to configure the world volume as part of the resolution of issue https://github.com/AIDASoft/DD4hep/issues/1064
     ```
    <world debug="true">
      <regionref   name="world_region"/>
      <limitsetref name="world_limits"/>
      <visref      name="world_vis"/>
    </world> 
     ```
    Technically the implementation are XML utilities, which are used both by the plugin and the Compact converter.
  
  - Propagate the changes to the world volume to Geant4, which was not possible with DDG4 before, because production cuts and region settings for the world volume belong to Geant4 and are managed by Geant4. (also https://github.com/AIDASoft/DD4hep/issues/1064)
  - Side product: Add debug flags for the G4 LimitSet conversion. To enable the flags in the python setup:
  
    ```
      seq, act = m.geant4.addDetectorConstruction("Geant4DetectorGeometryConstruction/ConstructGeo")
      act.DebugLimits = True
     ```
  - Have the maps in DetectorData being named to ease debugging.
  - Add some XML attribute conversions (more user friendliness)
  - Add accessors to the PlacedVolume and the Volume handles to access the class name of the implementing class.
  - DDDigi: Add passing event parameters to the output and from the input record to the store. Needs testing though, 
    but this requires a new release of podio.

* 2023-03-02 Markus Frank ([PR#1070](https://github.com/aidasoft/DD4hep/pull/1070))
  - PR 1068 was incomplete (OpticalTracker). Add the missing pieces.

* 2023-03-01 Christopher Dilks ([PR#1068](https://github.com/aidasoft/DD4hep/pull/1068))
  - fix: fill energy deposition for `Geant4SensitiveAction<Geant4OpticalTracker>`

* 2023-03-01 Markus Frank ([PR#1066](https://github.com/aidasoft/DD4hep/pull/1066))
  - Add include directive in <plugins> section
    (https://github.com/AIDASoft/DD4hep/commit/43b66bfd145c9e58c91f2189c2a3671ef9b2ef8e)
    See Issue 1062 (https://github.com/AIDASoft/DD4hep/issues/1062)
  - With test: /examples/ClientTests/compact/IncludePlugins.xml
  - Some (mostly cosmetic) refactorization in DDDigi

# v01-25-01

* 2023-02-24 Andre Sailer ([PR#1063](https://github.com/aidasoft/dd4hep/pull/1063))
  * DDG4: fix -Wnon-pod-varargs in Geant4Output2EDM4hep, which fails on clang

Andre Sailer's avatar
Andre Sailer committed
# v01-25

* 2023-02-23 Thomas Madlener ([PR#1059](https://github.com/aidasoft/dd4hep/pull/1059))
  - Propagate HepMC event weights to EDM4hep and LCIO outputs of ddsim
    - Store all available weights and their names into the Frame / Event parameters, additionally store the first weight into the `weight` field of the `edm4hep::EventHeader`, resp. the `LCEvent`.
  - Add a possibility to store `double` values in `DDG4::EventParameters`

* 2023-02-23 Andre Sailer ([PR#920](https://github.com/aidasoft/dd4hep/pull/920))
  - DDG4: Geant4InputHandling: Try to address the simulation of Excited Ions. Print a warning if we encounter excited Ions that Geant4 cannot handle. Waiting for something else to provide the excitation energy information that is needed in this case. Fixes #918 and #1051 
  - DDSim: Catch and log exceptions for physics/userFunctions.

* 2023-02-21 Ben Couturier ([PR#1060](https://github.com/aidasoft/dd4hep/pull/1060))
  - Prevent a compact file from being loaded twice if the debug option "incguard" has been set.

* 2023-02-16 Andre Sailer ([PR#1061](https://github.com/aidasoft/dd4hep/pull/1061))
  - ddsim: make it possible to use batchmode with userInputPlugins only

* 2023-02-09 Markus Frank ([PR#1058](https://github.com/aidasoft/dd4hep/pull/1058))
  The export of dd4hep::units is problematic in the presence of identical libraries from DD4hep in the LD_LIBRARY_PATH:
  - The ROOT auto-class loading tends to falsely load these libraries if constants from the dd4hep namespace are requested in python. This is clearly wrong: the original libraries may not be binary compatible. The 
  - The export of the units using a helper class fixes this and ensures that the auto load mechanism is not automatically triggered. This is at least a formally correct solution until the auto load mechanism is better understood.
  
  - In the ROOT loader for DDDigi the `TBranch::SetAutoDelete(true)` was not set causing eventually double deletion and arbitrary crashes. Data read by DDDigi are put on the store and deleted by the application to allow subsequent reading for feeding other threads. If ROOT would take care of the deletion, multi-threaded processing is not possible.

* 2023-02-06 Dmitry Kalinkin ([PR#1055](https://github.com/aidasoft/dd4hep/pull/1055))
  - Pass `DYLD_LIBRARY_PATH` environment to listcomponents_dd4hep when generating rootmaps in CMake

* 2023-01-31 Paul Gessinger ([PR#1053](https://github.com/aidasoft/dd4hep/pull/1053))
  - Check podio version for compatibility in cmake

* 2023-01-30 Dmitry Kalinkin ([PR#1052](https://github.com/aidasoft/dd4hep/pull/1052))
  - Removed not implemented declaration of member function `PlacedVolume::flags()`

* 2023-01-26 Thomas Madlener ([PR#1050](https://github.com/aidasoft/dd4hep/pull/1050))
  - DDG4 EDM4hep Output: Write Frames into the `"runs"` category of the output file to store some run information.

Andre Sailer's avatar
Andre Sailer committed
# v01-24

* 2023-01-20 Andre Sailer ([PR#1048](https://github.com/AIDASoft/DD4hep/pull/1048))
  - add -Wno-psabi to compiler flags to ignore warnings about ABI changes that we will never have issues with. Fixes #1043

* 2023-01-20 Andre Sailer ([PR#1046](https://github.com/AIDASoft/DD4hep/pull/1046))
  - ParticleHandler: account for modified stepping actions, where tracking of a particle could be paused and later restarted.

* 2023-01-18 Andre Sailer ([PR#1045](https://github.com/AIDASoft/DD4hep/pull/1045))
  - thisdd4hep: fix an issue with environment paths getting dropped when they contain a complete substring of a path that is going to be added

* 2023-01-18 Markus Frank ([PR#1044](https://github.com/AIDASoft/DD4hep/pull/1044))
  - This PR addresses issue https://github.com/AIDASoft/DD4hep/issues/1037
    Rather than adding the beta as a double it was chosen to add at each step the track momentum
    in floats which for 4 more bytes offers more information.

* 2023-01-18 Andre Sailer ([PR#1042](https://github.com/AIDASoft/DD4hep/pull/1042))
  - ddsim: fix exception when a compactFile path not containing any slashes was given (fixes #1039 )

* 2023-01-17 Markus Frank ([PR#1041](https://github.com/AIDASoft/DD4hep/pull/1041))
  - Make DDDigi I/O interface more common and add edm4hep write/read example
  - Move DDG4 edm4hep writer to use podio Frames

* 2023-01-11 Markus Frank ([PR#1038](https://github.com/AIDASoft/DD4hep/pull/1038))
  - Improve DDDigi documentation when opening code sub-page
  - Silence flak8 warning from python
  - Fix a bug in the detector checksum module. Tested with TGeo units and G4 units of the CLICSiD model.
  - Propagate the configuration flag `DD4HEP_USE_EDM4HEP` to the generated dd4hep cmake of client projects.
  - Add DDDigi output module for the edm4hep format
  - Add DDDigi output module for the native ROOT objects including required dictionaries.

* 2022-12-15 Markus Frank ([PR#1032](https://github.com/AIDASoft/DD4hep/pull/1032))
  - Improve GDML export procedures
    -- Allow to set export precision in the plugin
    -- New ROOT release needed to properly export surfaces (current ROOT GDML export does not handle this currectly)
       See ROOT PR https://github.com/root-project/root/pull/11886
       See ROOT PR https://github.com/root-project/root/pull/11887
       See ROOT PR https://github.com/root-project/root/pull/11888
       See ROOT PR https://github.com/root-project/root/pull/11889
       See ROOT PR https://github.com/root-project/root/pull/11895
  - Remove some build errors for MAC

* 2022-12-09 Markus Frank ([PR#1030](https://github.com/AIDASoft/DD4hep/pull/1030))
  - Program GDML writer (requires new ROOT release to take advantage)

* 2022-12-09 Markus Frank ([PR#1029](https://github.com/AIDASoft/DD4hep/pull/1029))
  - Improve DDDigi package doc
  - Bug fix in detector checksum
  - Remove flak8 warnings

* 2022-12-06 Markus Frank ([PR#1028](https://github.com/AIDASoft/DD4hep/pull/1028))
  - Add detector checksum facility as plugin: Compare different detector setups
  - Gives identical hash results for TGeo units and G4 units
  - Supports detector dumps with "unified" strings for debugging
  ```
  Usage: -plugin DD4hepDetectorChecksum -arg [-arg]                             
  
       -detector <string>     Top level DetElement path. Default: '/world'        
       -readout               also hash the detector's readout properties         
                              (sensitive det, id desc, segmentation)              
                              default: false                                      
                                                                                  
     Debugging: Dump individual hash codes (debug>=1)                             
     Debugging: and the hashed string (debug>2)                                   
       -dump_elements         Dump hashes of used elements                        
       -dump_materials        Dump hashes of used materials                       
       -dump_solids           Dump hashes of used solids                          
       -dump_volumes          Dump hashes of used volumes                         
       -dump_placements       Dump hashes of used placements                      
       -dump_detelements      Dump hashes of used detelements                     
       -dump_sensitive        Dump hashes of sensitive detectors                  
       -dump_readout          Dump hashes of readout entities                     
       -dump_iddescriptors    Dump hashes of ID descriptors                       
       -dump_segmentations    Dump hashes of readout segmentations                
                                                                                  
     Modify units in the created hash strings (deprecated):                       
       -length_unit  <value>  Unit of length  as literal. default: mm             
       -angle_unit   <value>  Unit of angle   as literal. default: deg            
       -energy_unit  <value>  Unit of energy  as literal. default: GeV            
       -density_unit <value>  Unit of density as literal. default: g/cm3          
       -atomic_unit <value>   Unit of atomic weight as literal. default: g/mole   
                                                                                  
       -debug <number>        Enable debug printouts.                             
       -help                  Print this help output
  ```

* 2022-11-30 Kolja Kauder ([PR#1017](https://github.com/AIDASoft/DD4hep/pull/1017))
  - Final state HepMC particles were all attached to (0,0,0). Fixed by switching vertex creation for parentless particles to using their end-point instead, fixes #1013

* 2022-11-26 Markus Frank ([PR#1026](https://github.com/AIDASoft/DD4hep/pull/1026))
  - Fixed some coverity defects recently reported
  - Fix Geant4Converter bug: Protect for reflected assembly shapes.
  - Added feature to Geant4Output2ROOT to change file when the run number changes (ie. for each /run/beamOn command)
  - Modify and enhance the MiniTel example in ClientTests to serve as a small, but flexible testbed for DDDigi
  - Add multiple DDDigi tests using the modified MiniTel
    o Data generator using DDG4
    o See examples/DDDigi/scripts for the tests:
       o multiple interactions
       o spillover events
       o Container parallelization
       o Segmentation parallization
  - Started to implement a checksum mechanism based on well formatted XML dumps similar to GDML, but with
    well defined floating point precision.
    o See https://github.com/AIDASoft/DD4hep/issues/994 for details
    o first and incomplete dump for shapes.
    o to be completed eventually
    o whoever feels like it can become involved to implement such dumps for other objects:
      - elements, isotopes, materials, DetElements, Volumes, Placements etc.

* 2022-11-25 jmcarcell ([PR#1024](https://github.com/AIDASoft/DD4hep/pull/1024))
  - Fix compiler warning about unused variable
  - Fix warning in example test and fix also the test, it was comparing `char* == char*` which is almost never true

* 2022-11-24 Wouter Deconinck ([PR#1012](https://github.com/AIDASoft/DD4hep/pull/1012))
  - DDG4: Geant4TCUserParticleHandler: Allow for asymmetric tracking region with `tracker_region_zmin`

* 2022-11-22 Markus Frank ([PR#1023](https://github.com/AIDASoft/DD4hep/pull/1023))
  Take into account suggestions from PR https://github.com/AIDASoft/DD4hep/pull/1021

* 2022-11-22 Markus Frank ([PR#1021](https://github.com/AIDASoft/DD4hep/pull/1021))
  - Implemented issue https://github.com/AIDASoft/DD4hep/issues/1010: Changing Geant4 physics flags 
    o Extended the Geant4UIManager to support command queues at various stages of the program:
      -- configure
      -- initialize
      -- pre-run
      -- post-run
      -- terminate
    o Added interface function to directly communicate with the G4UI using string commands at any time
      from python.
    o Extended Geant4Kernel functionality to allow client actions to subscribe to stages of the program
      and perform dedicated actions on:
      -- configure
      -- initialize
      -- terminate
      As an example please see DDG4/src/Geant4UIManager.cpp
  
  - Dropped issue https://github.com/AIDASoft/DD4hep/issues/1004 after some tests and investigation:
    This issue cannot be resolved, because MC records may also be read without Geant4 and a physics list being initialized.
    Hence the event readers cannot implement such a feature if the event record does not support charge, but only the PDG code.
    Conclusion is to best update the charge of particles at the output stage using the PDG code or to implement an event action,
    which performs this actions right before the output stage.
  - Simplified component properties. 
  - Improvements to DDDigi (work in progress)

* 2022-11-17 Andre Sailer ([PR#1019](https://github.com/AIDASoft/DD4hep/pull/1019))
  - LCIOConversions: fix attaching SimCaloHit collections to event, this was accidentally dropped in #922

* 2022-11-16 Jonas Hahnfeld ([PR#1018](https://github.com/AIDASoft/DD4hep/pull/1018))
  - Fix build with GCC 8

* 2022-11-11 Wouter Deconinck ([PR#1011](https://github.com/AIDASoft/DD4hep/pull/1011))
  - Allow HepMC3 ROOT input files in ddsim when they end with `.hepmc3.tree.root`

* 2022-11-10 Wouter Deconinck ([PR#989](https://github.com/AIDASoft/DD4hep/pull/989))
  - ddsim: Automatically interpret '.hepmc3' input files

* 2022-11-03 Andre Sailer ([PR#1005](https://github.com/AIDASoft/DD4hep/pull/1005))
  - Examples: OpticalTracker: declare dependency on DDRec
  - Docs: fix some typos noted in #1003

* 2022-10-30 Markus Frank ([PR#1002](https://github.com/AIDASoft/DD4hep/pull/1002))
  - Fix to issue https://github.com/AIDASoft/DD4hep/issues/1000 and https://github.com/AIDASoft/DD4hep/issues/999

* 2022-10-29 Markus Frank ([PR#998](https://github.com/AIDASoft/DD4hep/pull/998))
  - DDCore
    -- Add string hash function for 8 and 16 bit hash results
    -- Add position transformations (world, detector element) to volume manager
  
  - DDG4
    -- Fix interface to Geant4StackingAction. Add missing function interface to allow access to ClassifyNewTrack.
       Also pass the current stacking manager reference to all user callbacks.
    -- Add simple example to test the functionality  examples/DDG4/scrips/TestStacking.py
  
  - DDDigi
    -- Add some processor plugins for simple data processing.
    -- Enhance the usage of the Key identifier.
    -- Add several test scripts in the example area.
  
  - examples
    -- Reduce the test execution time of the top CPU consumers by reducing the number of simulated events.

* 2022-10-24 Paul Gessinger ([PR#997](https://github.com/AIDASoft/DD4hep/pull/997))
  - DD4HEP_RELAX_PYVER is exported to `DD4hepConfig.cmake`.

* 2022-10-22 Andre Sailer ([PR#996](https://github.com/AIDASoft/DD4hep/pull/996))
  - DDSim: fix bug preventing the use of integers for the verbosity level (-v/--printLevel, --output.input etc.) fixes #992

* 2022-10-17 Andre Sailer ([PR#987](https://github.com/AIDASoft/DD4hep/pull/987))
  - DDEve: Adapt to renamed header in upcoming ROOT 6.28

* 2022-10-17 Wouter Deconinck ([PR#986](https://github.com/AIDASoft/DD4hep/pull/986))
  - Shapes::Trap: Fix the 4-argument trapezoidal prism constructor (again)

* 2022-10-10 Wouter Deconinck ([PR#983](https://github.com/AIDASoft/DD4hep/pull/983))
  - Ensure that closed tessellated solids are converted to closed solids in geant4

Andre Sailer's avatar
Andre Sailer committed
# v01-23

* 2022-09-28 Wouter Deconinck ([PR#982](https://github.com/aidasoft/dd4hep/pull/982))
  - ddsim: set eta_min, eta_max correctly for `ddsim --gun.distribution eta`

* 2022-09-23 Markus Frank ([PR#980](https://github.com/aidasoft/dd4hep/pull/980))
  Remove using declarations in root-cling dictionary files to avoid interpreter clashes with the global namespace
  
  Affected files:
  -   DDCore/src/GeoDictionary.h
  -   DDCore/src/PropertyDictionary.h
  -   DDCore/src/RootDictionary.h
  -   DDCore/src/SegmentationDictionary.h
  -   DDEve/include/DDEve/Dictionary.h
  -   DDG4/include/DDG4/DDG4Dict.h

* 2022-09-23 Marco Clemencic ([PR#979](https://github.com/aidasoft/dd4hep/pull/979))
  - Use explicit namespaces in DDCond dictionary

* 2022-09-19 Wouter Deconinck ([PR#976](https://github.com/aidasoft/dd4hep/pull/976))
  - `geoConverter -compact2tgeo` to write TGeo geometry to ROOT file

* 2022-09-19 Christopher Dilks ([PR#974](https://github.com/aidasoft/dd4hep/pull/974))
  - add example RICH detector, demonstrating and testing `Geant4OpticalTrackerAction`

* 2022-09-16 Wouter Deconinck ([PR#975](https://github.com/aidasoft/dd4hep/pull/975))
  - materialBudget: enable use with asymmetric detectors: adding thetaMin/thetaMax/etaMin to the steering file

* 2022-09-15 Wouter Deconinck ([PR#967](https://github.com/aidasoft/dd4hep/pull/967))
  - Geant4OpticalTrackerAction which stops-and-kills optical photons for e.g. SiPM sensor planes

* 2022-09-12 Christopher Dilks ([PR#973](https://github.com/aidasoft/dd4hep/pull/973))
  - fix typo in `examples/README.md`: `cmake` option `DD4HEP_BUILD_EXAMPLES` should be `DD4HEP_EXAMPLES`

* 2022-09-07 Dmitry Kalinkin ([PR#972](https://github.com/aidasoft/dd4hep/pull/972))
  - Refactor thisdd4hep.sh to use local variables where possible to prevent user environment corruption.

* 2022-09-01 Andre Sailer ([PR#969](https://github.com/aidasoft/dd4hep/pull/969))
  - DDSim: ddsim now prints out if the defaultFilter or if no filter is used for a sensitive detector

* 2022-09-01 Wouter Deconinck ([PR#968](https://github.com/aidasoft/dd4hep/pull/968))
  - ddsin: Add `--runType qt` support for enabling the graphical Qt interface for geant4
  - ddsim: change shell type to tcsh: enabling tab completion when Geant4 offers it

* 2022-08-26 Andre Sailer ([PR#962](https://github.com/aidasoft/dd4hep/pull/962))
  - DDCore: DetectorInfo: make INFO attributes optional, fixes #960

* 2022-08-25 Andre Sailer ([PR#963](https://github.com/aidasoft/dd4hep/pull/963))
  - ChannelingCrystalMaterial: fix crystal_orientation to be constPropertyRef

* 2022-08-25 Andre Sailer ([PR#961](https://github.com/aidasoft/dd4hep/pull/961))
  - DDSim: fix example for adding user physics list extension

Andre Sailer's avatar
Andre Sailer committed
# v01-22

* 2022-08-16 Andre Sailer ([PR#957](https://github.com/aidasoft/dd4hep/pull/957))
  - CI: add check for header guards

* 2022-08-15 Andre Sailer ([PR#956](https://github.com/aidasoft/dd4hep/pull/956))
  - CI: Add test with Geant4Units enabled

* 2022-08-15 Andre Sailer ([PR#946](https://github.com/aidasoft/dd4hep/pull/946))
  - CI changes, for discussion

* 2022-08-11 Markus Frank ([PR#954](https://github.com/aidasoft/dd4hep/pull/954))
  Before starting to parse XML files, programatically set the locale to "C" if any of the three
  - LC_NUMERIC,
  - LC_TIME,
  - LC_CTYPE
  Is not set to "C".
  
  Addresses issue https://github.com/AIDASoft/DD4hep/issues/913.

* 2022-08-11 Andre Sailer ([PR#953](https://github.com/aidasoft/dd4hep/pull/953))
  - DDSim: find the python executable used during build and set that for the hashbang, e.g. python3.9 instead of python. Fixes #952

* 2022-08-10 Markus Frank ([PR#951](https://github.com/aidasoft/dd4hep/pull/951))
  - Allow to set MeanExcEnergy, MeanEnergyPerIonPair and BirksConstant in G4Materials ionisation parameters.
    Specify values in the compact description of the materials:
  ```
      <material name="Ice">
        <D type="density" value="1.0" unit="g/cm3"/>
        <composite n="2" ref="H"/>
        <composite n="1" ref="O"/>
        <constant name="BirksConstant"        value="123.456*mm/MeV"/>
        <constant name="MeanExcitationEnergy" value="79.7*eV"/>
        <constant name="MeanEnergyPerIonPair" value="50*eV"/>
      </material>
  ```
  Units will be converted to Geant4 units in the converter.
  See issue https://github.com/AIDASoft/DD4hep/issues/890 for details.
  
  If in DDG4 the the material debugging is enabled:
  ```
    # Configure G4 geometry setup
    seq, act = geant4.addDetectorConstruction("Geant4DetectorGeometryConstruction/ConstructGeo")
    act.DebugMaterials = True
  ```
  this gives the following output:
  ```
  Ice                    ++ Created G4 material  Material:      Ice    density:  1.000 g/cm3   RadL:  36.083 cm   Nucl.Int.Length:  75.375 cm 
                        Imean:  79.700 eV   temperature: 293.15 K  pressure:   1.00 atm
  
     --->  Element: H (H)   Z =  1.0   N =     1   A =  1.008 g/mole
           --->  Isotope:    H1   Z =  1   N =   1   A =   1.01 g/mole   abundance: 99.989 %
           --->  Isotope:    H2   Z =  1   N =   2   A =   2.01 g/mole   abundance:  0.011 %
            ElmMassFraction:  11.19 %  ElmAbundance  66.67 % 
  
     --->  Element: O (O)   Z =  8.0   N =    16   A = 15.999 g/mole
           --->  Isotope:   O16   Z =  8   N =  16   A =  15.99 g/mole   abundance: 99.757 %
           --->  Isotope:   O17   Z =  8   N =  17   A =  17.00 g/mole   abundance:  0.038 %
           --->  Isotope:   O18   Z =  8   N =  18   A =  18.00 g/mole   abundance:  0.205 %
            ElmMassFraction:  88.81 %  ElmAbundance  33.33 % 
            log(MEE): -9.437  Birk's constant: 123.5 [mm/MeV]  Mean Energy Per Ion Pair: 50 [eV]
  ```

* 2022-08-10 Markus Frank ([PR#950](https://github.com/aidasoft/dd4hep/pull/950))
  On request from out LHC colleagues DD4hep supports channeling physics in Geant4.
  To support channeling physics in Geant4 it is necessary to enable the transparent 
  creation of G4ExtendedMaterial and G4LogicalCrystalVolume instances.
  This can be done in DD4hep with the supply of material and volume properties in DD4hep.
  
  Material properties can be supplied in the compact description like here:
  ```
      <material name="Ice">
        <D type="density" value="1.0" unit="g/cm3"/>
        <composite n="2" ref="H"/>
        <composite n="1" ref="O"/>
        <constant name="Geant4-plugin:material"            option="ChannelingCrystalMaterial"/>
        <constant name="Geant4-ignore:crystal_data"        option="${DD4hepExamplesINSTALL}/examples/DDG4/data/Si220pl/Si220pl"/>
        <constant name="Geant4-ignore:crystal_orientation" option="(1,0,0)"/>
      </material>
  ```
  The property starting with the tag `Geant4-plugin` is used to determine the proper plugin
  preparing the G4ExtendedMaterial instance.
  All properties with tags `Geant4-ignore` are not passed as material properties to Geant4.
  Properties starting with this tag can be used by users to configure the G4ExtendedMaterial instance.
  
  Volumes can as well have properties as this C++ example shows:
  ```
    Volume vol = Volume("Volume", solid, material);
    xml_elt_t ec = ...;
    vol.addProperty(ec.attr<std::string>(_U(name)), ec.attr<std::string>(_U(value)));
  ```
  with values supplied by XML:
  ```
    <property name="Geant4-plugin" value="ChannelingCrystalVolume"/>
  ```
  For more details see the example `<DD4hep>/examples/DDG4/compact/Channeling.xml`.
  Again the property `Geant4-plugin` is used to call a plugin to create sub-classes
  of G4LogicalVolume like G4LogicalCrystalVolume. 
  
  An example was prepared in `<DD4hep>/examples/DDG4` containing:
  - a compact description: `compact/Channeling.xml`
  - an example factory for the G4ExtendedMaterial: `src/ChannelingCrystalMaterial.cpp`
  - an example factory for the G4LogicalCrystalVolume: `src/ChannelingCrystalVolume.cpp`
  - A script invoking Geant4 to test this setup: `scripts/Channeling.py`

* 2022-08-09 Dmitry Kalinkin ([PR#949](https://github.com/aidasoft/dd4hep/pull/949))
  - DDSim: restore the fixed momentum behaviour of `--gun.energy`, independent of the isotrop setting for the particle gun. If gun.energy is set, the momentum will have this value. If it is not set, momentumMin and momentumMax will be used to pick a value.

* 2022-08-05 Andre Sailer ([PR#942](https://github.com/aidasoft/dd4hep/pull/942))
  - DDSim: add option to set userInputPlugin for simulation by adding a plugin for themselves, and this to the ddsim steering file (for #940)
     ```python
        def exampleUserPlugin(dd4hepSimulation):
          '''Example code for user created plugin.
  
          :param DD4hepSimulation dd4hepSimulation: The DD4hepSimulation instance, so all parameters can be accessed
          :return: GeneratorAction
          '''
          from DDG4 import GeneratorAction, Kernel
          # Geant4InputAction is the type of plugin, Cry1 just an identifier
          gen = GeneratorAction(Kernel(), 'Geant4InputAction/Cry1' , True)
          # CRYEventReader is the actual plugin, steeringFile its constructor parameter
          gen.Input = 'CRYEventReader|' + 'steeringFile'
          # we can give a dictionary of Parameters that has to be interpreted by the setParameters function of the plugin
          gen.Parameters = {'DataFilePath': '/path/to/files/data'}
          gen.enableUI()
          return gen
  
        SIM.inputConfig.userInputPlugin = exampleUserPlugin
     ```

* 2022-08-04 Andrea Ciarma ([PR#944](https://github.com/aidasoft/dd4hep/pull/944))
  * Mask_o1: Added the possibility to have sensitive elements of type Mask_o1_v01_geo by adding a `sensitive="sensitiveType"` attribute

* 2022-08-02 Juraj Smiesko ([PR#941](https://github.com/aidasoft/dd4hep/pull/941))
  * checkOverlaps.py: Adding possibility to provide multiple compact files
  * checkOverlaps.py: replace optparse by argparse for up-to-date python

* 2022-08-01 Markus Frank ([PR#939](https://github.com/aidasoft/dd4hep/pull/939))
  - Follow up of https://github.com/AIDASoft/DD4hep/pull/938. 
    Improves the DetectorCheck plugin.
  - Add example with an "ill" detector description that triggers the DetectorCheck plugin
    to complain and to eject pathes to problematic detector elements ect.

* 2022-07-29 Markus Frank ([PR#938](https://github.com/aidasoft/dd4hep/pull/938))
  - Fix type in DDCore/src/DD4hepRootPersistency.cpp
  - Add operator== and operator != to handles of DetElement, SensitiveDetector
    Volume and PlacedVolume. Check pointer values for equality.
  - Add plugin DD4hep_DetectorCheck. Improves and replaces DD4hep_VolumeMgrTest.
    o Test checks the strutural tree of a given top element
    o Test checks the geometry tree of a given top element
    o If physical volume ids are properly placed these can also be checked.
  ```
  DD4hep_DetectorCheck -option [-option]                                         
    -help                        Print this help message                         
    -name  <subdetector name>    Name of the subdetector to be checked           
                                 "ALL" or "all": loop over known subdetectors
                                 "world" start from the mother of all...       
    -structure                   Check structural tree consistency               
    -geometry                    Check geometry tree consistency                 
    -sensitve                    Check consistency between detector and volume   
                                 settings of sensitive detectors.                
    -volmgr                      Check volume manager entries against volIDs of  
                                 sensitive volume placements.                  
  
                                 NOTE: Option requires proper PhysVolID setup    
                                 of the sensitive volume placements !
  ```

* 2022-07-27 Juraj Smiesko ([PR#937](https://github.com/aidasoft/dd4hep/pull/937))
  - Improving error message when setting detector type flags

* 2022-07-27 Andre Sailer ([PR#935](https://github.com/aidasoft/dd4hep/pull/935))
  - ddsim: Fix setting of zeroTimePDGs, previously this value was not forwarded from config to the program
  - particle.tbl: change 523 to unstable (fixes #909)
  - Geant4InputHandling: add exception when encountering stable particles with daughters that are marked for simulation (implements feature of #909)
  - Geant4InputHandling: reject particles with GEN_DOC, GEN_BEAM, GEN_OTHER (fixes part of #918)

* 2022-07-26 Markus Frank ([PR#936](https://github.com/aidasoft/dd4hep/pull/936))
  - Recursive calls to apply-plugins overwrote the return code.
  - This MR fixes issue https://github.com/AIDASoft/DD4hep/issues/875
  
  - Support for 1D, 2D and 3D parameterised volumes.
    (Outstanding request by S.Ko)
    1. TGeo does not support parametrized volumes intrinsically.
      On the dd4hep/TGeo side these are implemented by multiple placements 
      according to the user supplied transformation matrices.
      For details see the calls in `dd4hep::Volume::paramVolume<dim>D(...)`
    2. When translated to Geant4, the structures are identified and
      the proper Geant4 parameterisation is created.
    3. An example can be found in:
      - `examples/ClientTests/src/ParamVolume_geo.cpp`
      - to display: `geoDisplay examples/ClientTests/compact/ParamVolume<dim>D.xml`
      - the Geant4 conversion is excercised with the scripts:
        ```
        python examples/ClientTests/scripts/ParamVolume.py \
           -geometry examples/ClientTests/compact/ParamVolume<dim>D.xml \
           -vis -macro examples/ClientTests/compact/ParamVolume.mac ```

Andre Sailer's avatar
Andre Sailer committed
# v01-21

* 2022-07-19 Markus Frank ([PR#933](https://github.com/aidasoft/DD4hep/pull/933))
  The fast simulation handling in Geant4 includes the GFlash interface
  as implemented in `<geant40-source>/source/parameterisations/gflash`
  and a fast simulation interface as provided by 
  `<geant40-source>/source/processes/parameterisation`
  
  This MR allows to handle both mechanisms using the same callbacks 
  in the Geant4SensitiveActions using the callback specialization:
  ```
        /// GFLASH/FastSim interface: Method for generating hit(s) using the information of the fast simulation spot object.
        virtual bool processFastSim(const Geant4FastSimSpot* spot, G4TouchableHistory* history)  final;
  ```
  in addition to the regular callback for full simulation:
  ```
        /// G4VSensitiveDetector interface: Method for generating hit(s) using the G4Step object.
        virtual bool process(const G4Step* step,G4TouchableHistory* history)  final;
  ```
  The `Geant4FastSimSpot` is inspired by the `G4GFlashSpot`, but avoids the specialization towards GFlash
  given that the `G4FastHit` and the `G4GFlashEnergySpot` are equivalent.
  Together with the helper class `Geant4FastSimHandler` simple sensitive detector callbacks
  can be implemented like:
  ```
      /// GFlash/FastSim interface: Method for generating hit(s) using the information of Geant4FastSimSpot object.
      template <> bool
      Geant4SensitiveAction<Geant4Tracker>::processFastSim(const Geant4FastSimSpot* spot,
  							 G4TouchableHistory* /* hist */)
      {
        typedef Geant4Tracker::Hit Hit;
        Geant4FastSimHandler h(spot);
        Hit* hit = new Hit(h.trkID(), h.trkPdgID(), h.deposit(), h.track->GetGlobalTime());
        hit->cellID        = cellID(h.touchable(), h.avgPositionG4());
        hit->energyDeposit = h.deposit();
        hit->position      = h.avgPosition();
        hit->momentum      = h.momentum();
        hit->length        = 0e0;
        collection(m_collectionID)->add(hit);
        return true;
      }
  ```
  Callbacks with this signature are called both for GFlash and the G4 fast simulation.
  
  To simplify the user defined construction of fast simulation shower models
  the helper class `Geant4FastSimShowerModel` is implemented as a `Geant4Action`
  and hence allows to have options to be set by the user (including python).
  
  As an illustration two fast simulation shower models were implemented in
  `<dd4hep>/DDG4/plugins/Geant4P1ShowerModel.cpp` which were directly deduced
  from the Geant4 example `<geant4-source>/examples/extended/parameterisations/Par01`.
  Please see the source files for details.
  
  To execute GFlash or fast simulation to simple python examples are provided
  using simple silicon blocks as sensitive volumes:
  - GFlash `<dd4hep-dir>/examples/ClientTests/scripts/SiliconBlockGFlash.py`
  - Fast simulation `<dd4hep-dir>/examples/ClientTests/scripts/SiliconBlockFastSim.py`
  
  To enable either the following actions are required:
  1. Enable fast simulation for certain particles in the physics list:
  ```  # Build the physics list:
    phys = geant4.setupPhysics('FTFP_BERT')
    ph = DDG4.PhysicsList(kernel, str('Geant4FastPhysics/FastPhysicsList'))
    ph.EnabledParticles = ['e+', 'e-']
    ph.enableUI()
    phys.adopt(ph)
  ```
  This step is identical for GFlash and fast simulation physics.
  2. Enable the shower mode:
  ```  model = DDG4.DetectorConstruction(kernel, str('Geant4Par01EMShowerModel/ShowerModel'))
    # Mandatory model parameters
    model.RegionName = 'SiRegion'
    model.Material = 'Silicon'
    model.ApplicableParticles = ['e+', 'e-']
    model.Etrigger = {'e+': 0.1 * GeV, 'e-': 0.1 * GeV}
    model.Enable = True
    model.enableUI()
  ```
  Here the options must be set according to the parameters required by the shower models.
  
  The G4 fast simulation interface is only functional for Geant4 version >= 10.07.
  For lower versions of Geant4 missing classes are stubbed to allow the compilation.

* 2022-07-18 Paul Gessinger ([PR#931](https://github.com/aidasoft/DD4hep/pull/931))
  - Update `VariantParameters`: `value_or` is const (returns by value anyway), add non-const `get` method

* 2022-07-15 Markus Frank ([PR#930](https://github.com/aidasoft/DD4hep/pull/930))
  - Fix some handler
  - Add 2 examples to test the functionality

* 2022-07-14 Markus Frank ([PR#929](https://github.com/aidasoft/DD4hep/pull/929))
  - First attempt to implement GFlash parametrization for DDG4
  - Example is in examples/ClientTests/scripts/SiliconBlockGFlash.py
    Relevant code changes are for the detector construction:
    ```
    seq, act = geant4.addDetectorConstruction('Geant4DetectorGeometryConstruction/ConstructGeo')
    ....
    # Enable GFlash shower model
    model = DDG4.DetectorConstruction(kernel, str('Geant4GFlashShowerModel/ShowerModel'))
    model.Parametrization = 'GFlashHomoShowerParameterisation'
    # Mandatory model parameters
    model.RegionName = 'SiRegion'
    model.Material = 'Silicon'
    model.Enable = True
    # Energy boundaries are optional
    model.Emin  = {'e+': 0.1*GeV, 'e-': 0.1*GeV }  # Units in GeV
    model.Ekill = {'e+': 0.1*MeV, 'e-': 0.1*MeV }
    model.enableUI()
    seq.adopt(model)
    ```
    and the physics list.
    ```
    # Now build the physics list:
    phys = geant4.setupPhysics('FTFP_BERT')
    ph = DDG4.PhysicsList(kernel, str('Geant4FastPhysics/FastPhysicsList'))
    ph.EnabledParticles = ['e+', 'e-']
    ph.BeVerbose = True
    ph.enableUI()
    phys.adopt(ph)
    ```
  The setup of the regions is crucial for GFlash to work, because it applies to regions.
  For concrete detector constructors the proper regional setting are mandatory, but do not affect
  this implementation.

* 2022-07-12 Andre Sailer ([PR#928](https://github.com/aidasoft/DD4hep/pull/928))
  - CI: Due to incompatibilities we can no longer test macOS on github

* 2022-07-12 Markus Frank ([PR#927](https://github.com/aidasoft/DD4hep/pull/927))
  Easy possibility to store condition payloads as std::any.
  - Use of specialized handle class `dd4hep::ConditionAny` to support the functionality.
    The payload is automatically bound to an object of type std::any.
    Example code of constructor and how to access data:
     ```
    /// Emplacement construction
    std::vector<int> value;
    ... // fill data
    ConditionAny c2("name", "type", std::move(value));
  
    /// Construct conditions object with empty std::any