diff --git a/.clang-format b/.clang-format new file mode 100644 index 0000000..883d234 --- /dev/null +++ b/.clang-format @@ -0,0 +1,92 @@ +--- +Language: Cpp +AccessModifierOffset: -2 +AlignAfterOpenBracket: Align +AlignConsecutiveAssignments: true +AlignConsecutiveDeclarations: true +AlignEscapedNewlinesLeft: true +AlignOperands: true +AlignTrailingComments: true +AllowAllParametersOfDeclarationOnNextLine: true +AllowShortBlocksOnASingleLine: false +AllowShortCaseLabelsOnASingleLine: false +AllowShortFunctionsOnASingleLine: true +AllowShortIfStatementsOnASingleLine: false +AllowShortLoopsOnASingleLine: false +AlwaysBreakAfterDefinitionReturnType: None +AlwaysBreakAfterReturnType: None +AlwaysBreakBeforeMultilineStrings: true +AlwaysBreakTemplateDeclarations: false +BinPackArguments: true +BinPackParameters: true +BraceWrapping: + AfterClass: false + AfterControlStatement: false + AfterEnum: false + AfterFunction: false + AfterNamespace: false + AfterObjCDeclaration: false + AfterStruct: false + AfterUnion: false + BeforeCatch: false + BeforeElse: false + IndentBraces: false +BreakBeforeBinaryOperators: None +BreakBeforeBraces: Attach +BreakBeforeTernaryOperators: true +BreakConstructorInitializersBeforeComma: false +BreakAfterJavaFieldAnnotations: false +BreakStringLiterals: true +ColumnLimit: 120 +CommentPragmas: '^ IWYU pragma:' +ConstructorInitializerAllOnOneLineOrOnePerLine: true +ConstructorInitializerIndentWidth: 4 +ContinuationIndentWidth: 4 +Cpp11BracedListStyle: true +DerivePointerAlignment: false +DisableFormat: false +ExperimentalAutoDetectBinPacking: false +ForEachMacros: [ foreach, Q_FOREACH, BOOST_FOREACH ] +IncludeCategories: + - Regex: '^<.*\.h>' + Priority: 1 + - Regex: '^<.*' + Priority: 2 + - Regex: '.*' + Priority: 3 +IncludeIsMainRegex: '([-_](test|unittest))?$' +IndentCaseLabels: true +IndentWidth: 2 +IndentWrappedFunctionNames: false +KeepEmptyLinesAtTheStartOfBlocks: false +MacroBlockBegin: '' +MacroBlockEnd: '' +MaxEmptyLinesToKeep: 1 +NamespaceIndentation: All +ObjCBlockIndentWidth: 2 +ObjCSpaceAfterProperty: false +ObjCSpaceBeforeProtocolList: false +PenaltyBreakBeforeFirstCallParameter: 1 +PenaltyBreakComment: 300 +PenaltyBreakFirstLessLess: 120 +PenaltyBreakString: 1000 +PenaltyExcessCharacter: 1000000 +PenaltyReturnTypeOnItsOwnLine: 200 +PointerAlignment: Left +ReflowComments: false +SortIncludes: true +SpaceAfterCStyleCast: false +SpaceBeforeAssignmentOperators: true +SpaceBeforeParens: ControlStatements +SpaceInEmptyParentheses: false +SpacesBeforeTrailingComments: 2 +SpacesInAngles: false +SpacesInContainerLiterals: false +SpacesInCStyleCastParentheses: false +SpacesInParentheses: false +SpacesInSquareBrackets: false +Standard: Cpp11 +TabWidth: 4 +UseTab: Never +JavaScriptQuotes: Leave +... diff --git a/.github/scripts/clang-format-hook b/.github/scripts/clang-format-hook new file mode 100755 index 0000000..731de08 --- /dev/null +++ b/.github/scripts/clang-format-hook @@ -0,0 +1,21 @@ +#!/usr/bin/env bash + +# Thin wrapper around clang-format for easier to parse output from the +# pre-commit hook. +# +# Needs to work with multiple input files as pre-commit passes multiple files to +# the "executables" + +# Make sure that diff is actually recent enough (diffutils >= 3.4) to support +# colored output +COLOR_OUTPUT=$(diff --color=always <(echo) <(echo) > /dev/null 2>&1 && echo "--color=always") + +success=0 +for file in ${@}; do + if ! $(clang-format --style=file --Werror --dry-run ${file} > /dev/null 2>&1); then + echo "Necessary changes for: '${file}' (run 'clang-format --style=file -i ${file}' to fix it)" + diff ${COLOR_OUTPUT} -u ${file} <(clang-format --style=file ${file}) | tail -n +3 + success=1 + fi +done +exit ${success} diff --git a/.github/templates/apache-2.tmpl b/.github/templates/apache-2.tmpl new file mode 100644 index 0000000..f529936 --- /dev/null +++ b/.github/templates/apache-2.tmpl @@ -0,0 +1,16 @@ +Copyright (c) ${years} ${owner}. + +This file is part of ${projectname}. +See ${projecturl} for further info. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/.github/workflows/pre-commit.yaml b/.github/workflows/pre-commit.yaml new file mode 100644 index 0000000..4cc392c --- /dev/null +++ b/.github/workflows/pre-commit.yaml @@ -0,0 +1,17 @@ +name: pre-commit + +on: [push, pull_request] + +jobs: + pre-commit: + runs-on: ubuntu-22.04 + steps: + - uses: actions/checkout@v3 + - uses: cvmfs-contrib/github-action-cvmfs@v3 + - name: Run pre-commit + run: | + source /cvmfs/sw-nightlies.hsf.org/key4hep/setup.sh + cd ${GITHUB_WORKSPACE} + pre-commit run --show-diff-on-failure \ + --color=always \ + --all-files diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml new file mode 100644 index 0000000..3471c65 --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,43 @@ +name: linux + +on: [push, pull_request] + +jobs: + test: + runs-on: ubuntu-latest + strategy: + fail-fast: false + matrix: + SETUP: ['/cvmfs/sw.hsf.org/key4hep/setup.sh', '/cvmfs/sw-nightlies.hsf.org/key4hep/setup.sh'] + steps: + - uses: actions/checkout@v2 + - uses: cvmfs-contrib/github-action-cvmfs@v2 + - name: Start container + run: | + docker run -it --name CI_container -v ${GITHUB_WORKSPACE}:/Package -v /cvmfs:/cvmfs:shared -d ghcr.io/aidasoft/centos7:latest /bin/bash + - name: CMake Configure + run: | + docker exec CI_container /bin/bash -c 'cd Package;\ + mkdir -p build install;\ + source ${{ matrix.SETUP }};\ + cd build;\ + cmake -DCMAKE_INSTALL_PREFIX=../install -DCMAKE_CXX_STANDARD=17 -DCMAKE_CXX_FLAGS=" -fdiagnostics-color=always " -G Ninja ..;' + - name: Compile + run: | + docker exec CI_container /bin/bash -c 'cd ./Package;\ + source ${{ matrix.SETUP }};\ + cd build;\ + ninja -k0;' + - name: Install + run: | + docker exec CI_container /bin/bash -c 'cd ./Package;\ + source ${{ matrix.SETUP }};\ + cd build;\ + ninja -k0 install;' + - name: Test + run: | + docker exec CI_container /bin/bash -c 'cd ./Package;\ + source ${{ matrix.SETUP }};\ + cd build;\ + ninja -k0 && ctest --output-on-failure;' + diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..656d005 --- /dev/null +++ b/.gitignore @@ -0,0 +1,249 @@ +### File copied from https://github.com/key4hep/key4hep-dev-utils +### DO NOT EDIT, CHANGES WILL BE OVERWRITTEN + +### C++ ### +# Prerequisites +*.d + +# Compiled Object files +*.slo +*.lo +*.o +*.obj + +# Precompiled Headers +*.gch +*.pch + +# Compiled Dynamic libraries +*.so +*.dylib +*.dll + +# Fortran module files +*.mod +*.smod + +# Compiled Static libraries +*.lai +*.la +*.a +*.lib + +# Executables +*.exe +*.out +*.app + +### CMake ### +CMakeLists.txt.user +CMakeCache.txt +CMakeFiles +CMakeScripts +Testing +Makefile +cmake_install.cmake +install_manifest.txt +compile_commands.json +CTestTestfile.cmake +_deps + +### CMake Patch ### +# External projects +*-prefix/ + +### Python ### +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/#use-with-ide +.pdm.toml + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ + +### Python Patch ### +# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration +poetry.toml + +# ruff +.ruff_cache/ + +# LSP config files +pyrightconfig.json + +# Editors +.vscode +*~ +\#*\# +.projectile + +# Key4hep +spack-* +install/ +## podio +podio_generated_files.cmake +/include/podio/podioVersion.h +/python/podio/__init__.py +## EDM4hep +/python/edm4hep/__version__.py +edm4hep/edm4hep/ +edm4hep/src/ +## k4FWCore +test/k4FWCoreTest/**/*.root +## k4MarlinWrapper +test/inputFiles/*.slcio +test/gaudi_opts/testConverterConstants.py + diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..ecaf2d0 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,39 @@ +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v3.4.0 + hooks: + - id: mixed-line-ending + - id: trailing-whitespace + exclude: (doc/ReleaseNotes.md) + - repo: local + hooks: + # - id: clang-tidy + # name: clang-tidy + # entry: clang-tidy -warnings-as-errors='*' -p compile_commands.json + # types: [c++] + # exclude: (tests/(datamodel|src)/.*(h|cc)|podioVersion.in.h) + # language: system + - id: clang-format + name: clang-format + entry: .github/scripts/clang-format-hook + types: [c++] + language: system + # - id: pylint + # name: pylint + # entry: 'pylint --rcfile=.github/scripts/pylint.rc --msg-template="{path}:{line}: [{msg_id}({symbol}), {obj}] {msg}"' + # types: [python] + # language: system + # - id: flake8 + # name: flake8 + # entry: flake8 + # types: [python] + # language: system + - repo: https://github.com/johann-petrak/licenseheaders.git + rev: 'v0.8.8' + hooks: + - id: licenseheaders + args: ["-t", ".github/templates/apache-2.tmpl", "-y2020-2023", + "-o", "Key4hep-Project", + "-n", "Key4hep", + "-u", "https://key4hep.github.io/key4hep-doc/", + "-x", ".github/*", ".pre-commit-config.yaml", "README.md", "doc/ReleaseNotes.md", "-f"] diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100644 index 0000000..1f6b830 --- /dev/null +++ b/CMakeLists.txt @@ -0,0 +1,52 @@ +#[[ +Copyright (c) 2020-2023 Key4hep-Project. + +This file is part of Key4hep. +See https://key4hep.github.io/key4hep-doc/ for further info. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +]] +CMAKE_MINIMUM_REQUIRED(VERSION 3.12) + +project(k4Reco) + +# please keep this layout for version setting, used by the automatic tagging script +set(PACKAGE_VERSION_MAJOR 0) +set(PACKAGE_VERSION_MINOR 0) +set(PACKAGE_VERSION_PATCH 0) + +set(PACKAGE_VERSION "${PACKAGE_VERSION_MAJOR}.${PACKAGE_VERSION_MINOR}.${PACKAGE_VERSION_PATCH}") + +find_package(ROOT REQUIRED COMPONENTS RIO Tree) +find_package(EDM4HEP REQUIRED) +find_package(k4FWCore REQUIRED) +find_package(Gaudi REQUIRED) +find_package(DD4hep REQUIRED) +find_package(k4SimGeant4 REQUIRED) + +include(GNUInstallDirs) + +# Set up C++ Standard +# ``-DCMAKE_CXX_STANDARD=`` when invoking CMake +set(CMAKE_CXX_STANDARD 17 CACHE STRING "") + +if(NOT CMAKE_CXX_STANDARD MATCHES "14|17|20") + message(FATAL_ERROR "Unsupported C++ standard: ${CMAKE_CXX_STANDARD}") +endif() + +include(CTest) + +add_subdirectory(k4Reco) +add_subdirectory(test) + +include(cmake/CreateProjectConfig.cmake) diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..ee510e3 --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# k4Reco + +Gaudi algorithms for reconstruction using EDM4hep natively. diff --git a/cmake/CreateProjectConfig.cmake b/cmake/CreateProjectConfig.cmake new file mode 100644 index 0000000..3d9c73d --- /dev/null +++ b/cmake/CreateProjectConfig.cmake @@ -0,0 +1,40 @@ +############################################################################### +# This file contains the boilerplate to create the package config.cmake file +# used by other packages to find this package +# In principle no modifications are needed, except for the dependencies used +# in which case please modify the Project_Config_Template.cmake.in file +# and in rare cases the parts related to PATH_VARS here and in +# Project_Config_Template.cmake.in, but this should be rarely needed, because +# this information should go via the TARGETS +# +# This setup requires the use of GNUInstallDirs +############################################################################### + +configure_file(${CMAKE_CURRENT_LIST_DIR}/package_version_template.h.in + ${CMAKE_CURRENT_BINARY_DIR}/include/${CMAKE_PROJECT_NAME}/${CMAKE_PROJECT_NAME}Version.h) + +include(CMakePackageConfigHelpers) + +configure_package_config_file( + cmake/Project_Config_Template.cmake.in + ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_PROJECT_NAME}Config.cmake + INSTALL_DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/${CMAKE_PROJECT_NAME} + # Adapt if other variables are needed, also modify Project_Config_template.cmake.in + PATH_VARS CMAKE_INSTALL_INCLUDEDIR CMAKE_INSTALL_LIBDIR) + +write_basic_package_version_file( + ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_PROJECT_NAME}ConfigVersion.cmake + VERSION ${PACKAGE_VERSION_MAJOR}.${PACKAGE_VERSION_MINOR}.${PACKAGE_VERSION_PATCH} + COMPATIBILITY SameMajorVersion ) + +install(FILES ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_PROJECT_NAME}Config.cmake + ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_PROJECT_NAME}ConfigVersion.cmake + DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/${CMAKE_PROJECT_NAME} ) + +install(FILES ${CMAKE_CURRENT_BINARY_DIR}/include/${CMAKE_PROJECT_NAME}/${CMAKE_PROJECT_NAME}Version.h + DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/${CMAKE_PROJECT_NAME} ) + +install(EXPORT ${CMAKE_PROJECT_NAME}Targets + NAMESPACE ${CMAKE_PROJECT_NAME}:: + DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/${CMAKE_PROJECT_NAME}" + ) diff --git a/cmake/Project_Config_Template.cmake.in b/cmake/Project_Config_Template.cmake.in new file mode 100644 index 0000000..c27239a --- /dev/null +++ b/cmake/Project_Config_Template.cmake.in @@ -0,0 +1,19 @@ +set(@CMAKE_PROJECT_NAME@_VERSION @PACKAGE_VERSION@) + +@PACKAGE_INIT@ + +# modify if other PATH_VARS are used +set_and_check(@CMAKE_PROJECT_NAME@_INCLUDE_DIR "@PACKAGE_CMAKE_INSTALL_INCLUDEDIR@") +set_and_check(@CMAKE_PROJECT_NAME@_LIB_DIR "@PACKAGE_CMAKE_INSTALL_LIBDIR@") + +include(CMakeFindDependencyMacro) +# modify to reflect dependencies +find_dependency(ROOT COMPONENTS RIO Tree) +find_dependency(Gaudi) +find_dependency(EDM4HEP) +find_dependency(k4FWCore) + +include("${CMAKE_CURRENT_LIST_DIR}/@CMAKE_PROJECT_NAME@Targets.cmake") + +# Adapt to existing components +# check_required_components(@CMAKE_PROJECT_NAME@Plugins) diff --git a/cmake/package_version_template.h.in b/cmake/package_version_template.h.in new file mode 100644 index 0000000..c1969a6 --- /dev/null +++ b/cmake/package_version_template.h.in @@ -0,0 +1,88 @@ +#ifndef @CMAKE_PROJECT_NAME@_VERSION_H +#define @CMAKE_PROJECT_NAME@_VERSION_H + +#include +#include +#include +#if __cplusplus >= 202002L +#include +#endif + +// Some preprocessor constants and macros for the use cases where they might be +// necessary + +/// Define a version to be used in @CMAKE_PROJECT_NAME@. +#define @CMAKE_PROJECT_NAME@_GET_VERSION(major, minor, patch) (((unsigned long)(major) << 32) | ((unsigned long)(minor) << 16) | ((unsigned long)(patch))) +/// Get the major version from a preprocessor defined version +#define @CMAKE_PROJECT_NAME@_GET_MAJOR_VERSION(v) (((v) & (-1UL >> 16)) >> 32) +/// Get the minor version from a preprocessor defined version +#define @CMAKE_PROJECT_NAME@_GET_MINOR_VERSION(v) (((v) & (-1UL >> 32)) >> 16) +/// Get the patch version from a preprocessor defined version +#define @CMAKE_PROJECT_NAME@_GET_PATCH_VERSION(v) ((v) & (-1UL >> 48)) + +// Some helper constants that are populated by the cmake configure step +#define @CMAKE_PROJECT_NAME@_VERSION_MAJOR @PACKAGE_VERSION_MAJOR@ +#define @CMAKE_PROJECT_NAME@_VERSION_MINOR @PACKAGE_VERSION_MINOR@ +#define @CMAKE_PROJECT_NAME@_VERSION_PATCH @PACKAGE_VERSION_PATCH@ +#define @CMAKE_PROJECT_NAME@_VERSION @PACKAGE_VERSION@ + +/// The encoded version with which @CMAKE_PROJECT_NAME@ has been built +#define @CMAKE_PROJECT_NAME@_BUILD_VERSION @CMAKE_PROJECT_NAME@_VERSION(@CMAKE_PROJECT_NAME@_VERSION_MAJOR, @CMAKE_PROJECT_NAME@_VERSION_MINOR, @CMAKE_PROJECT_NAME@_VERSION_PATCH) + +namespace @CMAKE_PROJECT_NAME@::version { + + /** + * Version class consisting of 3 16 bit unsigned integers to hold the major, + * minor and patch version. Provides constexpr comparison operators that allow + * to use this class in constexpr-if clauses. + */ + struct Version { + uint16_t major{0}; + uint16_t minor{0}; + uint16_t patch{0}; + +#if __cplusplus >= 202002L + auto operator<=>(const Version&) const = default; +#else +// No spaceship yet in c++17 +#define DEFINE_COMP_OPERATOR(OP) \ + constexpr bool operator OP(const Version& o) const noexcept { \ + return std::tie(major, minor, patch) OP std::tie(o.major, o.minor, o.patch); \ + } + + DEFINE_COMP_OPERATOR(<) + DEFINE_COMP_OPERATOR(<=) + DEFINE_COMP_OPERATOR(>) + DEFINE_COMP_OPERATOR(>=) + DEFINE_COMP_OPERATOR(==) + DEFINE_COMP_OPERATOR(!=) + +#undef DEFINE_COMP_OPERATOR +#endif + + friend std::ostream& operator<<(std::ostream&, const Version& v); + }; + + inline std::ostream& operator<<(std::ostream& os, const Version& v) { + return os << v.major << "." << v.minor << "." << v.patch; + } + + /** + * The current build version + */ + static constexpr Version build_version{@CMAKE_PROJECT_NAME@_VERSION_MAJOR, @CMAKE_PROJECT_NAME@_VERSION_MINOR, @CMAKE_PROJECT_NAME@_VERSION_PATCH}; + + /** + * Decode a version from a 64 bit unsigned + */ + static constexpr Version decode_version(unsigned long version) noexcept { + return Version{ + (uint16_t) @CMAKE_PROJECT_NAME@_GET_MAJOR_VERSION(version), + (uint16_t) @CMAKE_PROJECT_NAME@_GET_MINOR_VERSION(version), + (uint16_t) @CMAKE_PROJECT_NAME@_GET_PATCH_VERSION(version) + }; + } +} + + +#endif diff --git a/doc/ReleaseNotes.md b/doc/ReleaseNotes.md new file mode 100644 index 0000000..c1914d3 --- /dev/null +++ b/doc/ReleaseNotes.md @@ -0,0 +1,3 @@ +# v00-01 + +* This file is also automatically populated by the tagging script \ No newline at end of file diff --git a/k4Reco/CMakeLists.txt b/k4Reco/CMakeLists.txt new file mode 100644 index 0000000..b8d466c --- /dev/null +++ b/k4Reco/CMakeLists.txt @@ -0,0 +1,18 @@ +#[[ +Copyright (c) 2020-2023 Key4hep-Project. + +This file is part of Key4hep. +See https://key4hep.github.io/key4hep-doc/ for further info. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +]] diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt new file mode 100644 index 0000000..88ec644 --- /dev/null +++ b/test/CMakeLists.txt @@ -0,0 +1,19 @@ +#[[ +Copyright (c) 2019-2023 Key4hep-Project. + +This file is part of Key4hep. +See https://key4hep.github.io/key4hep-doc/ for further info. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +]] +