Implementation of detector models in DD4hep, for use within the Key4hep software stack.
k4geo is distributed under the GPLv3 License
To build k4geo the following packages are required:
- DD4hep
- Geant4
- LCIO
- ROOT
They are available for instance via the Key4hep software stack, available on machines which have CVMFS mounted (e.g. lxplus).
git clone https://github.com/key4hep/k4geo.git
cd k4geo
mkdir build install
cd build
cmake .. -DCMAKE_INSTALL_PREFIX=../install
make install -j4
cd ..For people using the key4hep stack
The required packages for installation are available via the Key4hep software stack, available on machines which have CVMFS mounted (e.g. lxplus).
For development and to pick up the latest changes from the rest of the stack, source the nightly build:
source /cvmfs/sw-nightlies.hsf.org/key4hep/setup.shAlternatively, source the stable key4hep release:
source /cvmfs/sw.hsf.org/key4hep/setup.shBe aware that the version of k4geo you cloned may not be compatible with the stable release.
Sourcing the key4hep stack gives you access to the central version of k4geo via the $K4GEO environment variable.
When using the nightly stack, this will point to a k4geo version with all the latest updates (up until the previous night), whereas using the stable stack will point to the latest release version.
The local installation of k4geo is thus only required if you plan to make local changes for development.
See section After Installation for instructions how to use your local k4geo with the rest of the key4hep stack.
Same steps as above
To make the $K4GEO variable point to your local version of k4geo use the command
k4_local_repoin the top-level k4geo directory (where you should end up being after following the installation instructions above).
This command adds your local k4geo path to the environment variable $K4GEO such that other processes will use your version rather than the central one.
To simulate events for a given detector use the ddsim command:
ddsim -G -N 10 path/to/DETECTOR.xml-G enables the particle gun (10 GeV electrons per default) and -N 10 sets the number of events to 10.
Note that this uses the ddsim default settings which are likely not appropriate for your detector.
For detector specific configuration for running ddsim, see the following repositories:
ALLEGRO:${FCCCONFIG}/FullSim/ALLEGRO/IDEA:${FCCCONFIG}/FullSim/IDEA/ILD@FCCee:${FCCCONFIG}/FullSim/ILD_FCCee/
CLD:${CLDCONFIG}/share/CLDConfig/ILD: ILDConfig
k4CEDViewer/CED:- "CLIENT" - k4CEDViewer Codebase: https://github.com/key4hep/k4CEDViewer
- "SERVER" - CED Codebase: https://github.com/iLCSoft/CED
- for FCC detectors:
Phoenix@FCC- Codebase: https://github.com/HEP-FCC/phoenix-at-fcc
- Deployment: https://hep-fcc.github.io/phoenix-at-fcc/#/
Copyright (C), k4geo Authors
k4geo is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.