source/DD4hep/README.md

0001 # DD4hep (Detector Description for High Energy Physics)
0002 ![linux](https://github.com/AIDASoft/DD4hep/workflows/linux/badge.svg)
0003 ![python](https://github.com/AIDASoft/DD4hep/workflows/python/badge.svg)
0004 [![Coverity Status](https://scan.coverity.com/projects/10713/badge.svg)](https://scan.coverity.com/projects/DD4hep)
0005 [![DOI](https://zenodo.org/badge/60682190.svg)](https://zenodo.org/badge/latestdoi/60682190)
0006
0007 DD4hep is a software framework for providing a complete solution for full detector description (geometry, materials, visualization, readout, alignment, calibration, etc.) for the full experiment life cycle (detector concept development, detector optimization, construction, operation). It offers a consistent description through a single source of detector information for simulation, reconstruction, analysis, etc. It distributed under the [LGPLv3 License](http://www.gnu.org/licenses/lgpl-3.0.en.html)
0008
0009 [![License](https://www.gnu.org/graphics/lgplv3-147x51.png)](https://www.gnu.org/licenses/lgpl-3.0.en.html)
0010
0011 ## Pre-requisites and installation
0012 For information about how to install DD4hep see [this page](https://dd4hep.web.cern.ch/dd4hep/page/installation/)
0013
0014 ## Documentation
0015 User's Manuals can be found [here](https://dd4hep.web.cern.ch/dd4hep/page/users-manual/).
0016
0017 The Code Reference can be found [here](https://dd4hep.web.cern.ch/dd4hep/reference/).
0018
0019 ## Release notes
0020 Comprehensive release notes can be found under `doc/ReleaseNotes.md`
0021
0022 ## License and Copyright
0023
0024 Copyright (C), Organisation européenne pour la recherche nucléaire (CERN)
0025
0026 DD4hep is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
0027
0028 DD4hep 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 Lesser General Public License for more details.
0029
0030 You should have received a copy of the GNU Lesser General Public License long with this program. If not, see [https://www.gnu.org/licenses/](https://www.gnu.org/licenses/).
0031
0032