ReleaseNotes.md

# 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

# 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.