v00-99-03

v00-99-03 (last pre-release before v01-00)

This is the last planned pre-release version before v01-00. We plan no more changes to existing datatypes and we plan to tag v01-00 in about a month unless there are major issues still found with this release.

• 2025-10-24 Thomas Madlener (PR#456)

  • Bump the minimum version of podio to v01-06

• 2025-10-24 Juan Miguel Carceller (PR#453)

  • Fix the warnings related to isValid being deprecated (AIDASoft/podio#860) after the version of podio is bumped

• 2025-10-23 Juan Miguel Carceller (PR#457)

  • Remove unused variable in tools/CMakeLists.txt

• 2025-10-23 Juan Miguel Carceller (PR#454)

  • Use std::hypot when possible, prefer std::sqrt or std::hypot to sqrt

• 2025-10-21 Thomas Madlener (PR#446)

  • Remove the GeneratorPdfInfo datatype again, as the information it contains is only relevant for LO calculations and modern generators already take care of all of this using event weighting.
  • Rework the GeneratorEventParameters slightly to contain relevant information only. Information that is not applicable beyond LO is removed as again this is handled by the generator via event weighting.
  • These are breaking changes! Currently even files that have been written with an old version of the GeneratorEventParameters datatype will not be readable.

• 2025-10-14 Thomas Madlener (PR#452)

  • Do not build a separate edm4hepOldSchemas library (and dictionaries), but rather merge everything into the core EDM4hep library (and dictionaries).

• 2025-10-13 Juan Miguel Carceller (PR#443)

  • Use edm4hep.h in edm4hep2json to avoid hardcoding the types
  • Remove the test test_all_collections that reads the .cxx file to check if all the collections are there (but a comment could trigger a false positive, for example). There is still a test that runs edm4hep2json.
  • Bump the minimum required podio version to v01-05.

• 2025-09-23 Juan Miguel Carceller (PR#451)

  • Set ROOT_LIBRARY_PATH for tests to prevent it from being picked up from the environment

• 2025-09-23 Mateusz Jakub Fila (PR#450)

  • Add missing article data in the citation file so the BibTeX entry generated from it references the article correctly

• 2025-09-23 Mateusz Jakub Fila (PR#448)

  • Update comments referring to removed un-namespaced labels

• 2025-09-23 Thomas Madlener (PR#447)

  • Add some documentation about the subtle differences between LCIO and EDM4hep that are going to stay

• 2025-09-22 Juan Miguel Carceller (PR#445)

  • Remove support for CPack and the unused EDM4HEP.pc.in

• 2025-09-16 Mateusz Jakub Fila (PR#449)

  • Fixed another bunch of minor typos in docstrings and code comments

• 2025-09-02 Thomas Madlener (PR#404)

  • Replace the spin by helicity in MCParticle as the former is not usable without the full spin-density matrix whereas the latter is always well defined (or unset).
    • Defaults to 9 which is used to signify an unset value. Use hasHelicity to check whether the helicity is set

• 2025-08-26 Mateusz Jakub Fila (PR#444)

  • Include podio::UserDataCollection in file created by creatEDM4hepFile.py

• 2025-08-22 Mateusz Jakub Fila (PR#442)

  • Fix edm4hep2json not recognizing generator metadata types

• 2025-08-19 Juraj Smiesko (PR#441)

  • edm4hep2json: Adding isSubsetColl and collSchemaVersion to the JSON

• 2025-08-18 Thomas Madlener (PR#440)

  • Remove the deprecated labels that were originally defined outside the labels namespace.

• 2025-08-12 jmcarcell (PR#439)

  • Update the schema version after the changes in 32af1cb to avoid a warning every time that a file with CaloHitCollections is read

• 2025-08-12 jmcarcell (PR#438)

  • Add timeouts and fixtures to the tests that create and read files to make jobs that fail due to timeouts fail faster

• 2025-08-12 jmcarcell (PR#437)

  • Do not use the namespace HepMC3, removes a warning in unity builds

• 2025-08-12 jmcarcell (PR#436)

  • Remove the deprecated constructor, getters and setters

• 2025-08-12 jmcarcell (PR#435)

  • Add const to the argument of operator= in covariance matrices

• 2025-07-08 Mateusz Jakub Fila (PR#434)

  • Fixed blank documentation page with new doxygen version

• 2025-06-24 Thomas Madlener (PR#433)

  • Add a stepLength member to the CaloHitContribution
  • Clarify the docstring for the particle relation of the CaloHitContribution

v00-99-02

v00-99-02

• 2025-05-16 jmcarcell (PR#430)

  • Bump the required version of podio to 1.3. This is needed since ::typeName in link collections are only present in 1.3 and onwards. See #415

• 2025-05-14 Mateusz Jakub Fila (PR#429)

  • Update CI build badge in readme

• 2025-05-07 Thomas Madlener (PR#428)

  • Switch to latest actions for CI and enable caching of build artifacts for speeding up workflows

• 2025-05-07 Thomas Madlener (PR#413)

  • Limit the RNTuple backwards compatibility checks to only run with ROOT 6.34.04 and podio 1.2

• 2025-04-28 jmcarcell (PR#426)

  • Remove intermediate variables and make loading libraries and files consistent in __init__.py

• 2025-04-24 jmcarcell (PR#427)

  • Fix building with C++23 by not aliasing std::to_underlying to a type.

• 2025-04-01 Thomas Madlener (PR#425)

  • Switch pre-commit workflow to run on Key4hep nightlies to have a recent enough version of clang-format.

• 2025-04-01 Mateusz Jakub Fila (PR#422)

  • Add missing units for covariances, particle charge and other members

• 2025-04-01 Mateusz Jakub Fila (PR#414)

  • Replace podio::detail::linkCollTypeName with link collection typeName introduced in AIDASoft/podio#748

• 2025-03-21 BrieucF (PR#420)

  • Clarify the phi member of the TrackState
  • Specify units (radians) for members describing angles

• 2025-03-12 Mateusz Jakub Fila (PR#417)

  • Fix capitalization of eDepin yaml comments

• 2025-03-12 Graeme A Stewart (PR#408)

  • Add citation information to README.md and corresponding CITATION.cff file

• 2025-02-20 BrieucF (PR#406)

  • Clarify the comment on the Cluster direction members

• 2025-02-20 Mateusz Jakub Fila (PR#403)

  • Added a tab with standalone documentation pages in doxygen docs

• 2025-02-14 jmcarcell (PR#405)

  • Use std::swap (available now that we compile with C++20) and add a default
    case for the switch statement in the covariance matrix utils

• 2025-01-31 Paul Gessinger (PR#401)

  • Refactored YAML to use multiline strings

• 2025-01-31 Thomas Madlener (PR#398)

  • Make the EventHeader::eventNumber a 64 bit unsigned integer to avoid issues with the range of 32 bit integers.

• 2025-01-20 Mateusz Jakub Fila (PR#400)

  • Update C++ standard in clang_format to C++20

• 2025-01-16 Thomas Madlener (PR#395)

  • Add proper docstrings to all ParticleID related utilities (edm4hep::utils::ParticleIDMeta and edm4hep::utils::PIDHandler).
  • Add a addMetaInfos convenience overload to the PIDHandler to allow passing in several meta objects at once.

• 2025-01-14 Mateusz Jakub Fila (PR#399)

  • Fix component table in readme so it renders correctly

• 2025-01-10 Thomas Madlener (PR#389)

  • Remove the colorFlow member variable from the MCParticle since it is effectively unused (and should remain that way as there is no really correct way to use it without baking in generator specific assumptions).
    • This is a backwards compatible change w.r.t. readability of existing files (ROOT schema evolution handles this)
    • This is a breaking change for the API as {get,set}ColorFlow are removed from the MCParticle.
  • Remove the now unused edm4hep::Vector2i from the components

• 2024-12-20 Thomas Madlener (PR#394)

  • Make sure to also install the rootmap and rdict files for the old schemas library

• 2024-12-19 Mateusz Jakub Fila (PR#393)

  • Updated doxygen files to the version 1.11 so a dark mode renders properly

• 2024-12-19 Thomas Madlener (PR#392)

  • Bump the minimal podio version to 1.2, since the links category in the YAML file was only introduced there.

• 2024-12-19 Mateusz Jakub Fila (PR#391)

  • Install oldSchemas library and dictionary

• 2024-12-19 jmcarcell (PR#390)

  • Make the PIDHandler class non-copyable

• 2024-12-18 tmadlener (PR#373)

  • Switch to templated podio::Links for the Link datatypes
  • Bump the schema version to 3
  • Remove the legacy Association headers that were put in place for a smooth transition to Links

• 2024-11-08 Thomas Madlener (PR#381)

  • Make sure to only run backwards compatibility tests if we have a suitable version of ROOT to still read the RC2 RNTuples stored in the files.

• 2024-10-23 Thomas Madlener (PR#379)

  • Add an EDM4HEP_WITH_JSON cmake option (default ON) to be explicit about whether we want to build EDM4hep with JSON support or not.
    • Properly propagate this to downstream packages.
    • If set to OFF the edm4hep2json executable will not be built.

• 2024-10-23 Thomas Madlener (PR#378)

  • Make sure that the bits used for secondary and tertiary vertex bits are actually different

• 2024-10-16 jmcarcell (PR#377)

  • Remove redundant inline from templated utility functions.

• 2024-09-30 tmadlener (PR#376)

  • Use re.search instead of re.match in the version extraction of the backwards compatibility tests to make sure that versions can be extracted even if the file name doesn't start with the expected regex.

• 2024-09-30 Mateusz Jakub Fila (PR#370)

  • Added ruff pre-commit hook for formatting and linting python files
  • Reformatted and fixed warnings in python files
  • Added cmake targets ruff and ruff-format to lint and format python code

• 2024-09-26 tmadlener (PR#358)

  • Download files written with EDM4hep versions for which we promise backwards compatibility and check whether we can still read them correctly.

v00-99-01

v00-99-01

• 2024-09-20 tmadlener (PR#374)

  • Bump the minimal podio version to v01-01 because we need AIDASoft/podio#651 and AIDASoft/podio#678

• 2024-09-18 jmcarcell (PR#372)

  • Remove unused variable in edm4hep_testhepmc.cc

• 2024-09-17 jmcarcell (PR#371)

  • Relax the requirement for the HepMC3 version

• 2024-09-17 tmadlener (PR#369)

  • Skip the check for the full file in case the RNTuple has not been produce (e.g. if podio hasn't been built with RNTuple support)

• 2024-09-17 tmadlener (PR#367)

  • Fix the cmake warning related to HepPDT
  • Make sure that the tests that are enabled by this actually build and run with a suitable HepMC3 version

• 2024-09-16 jmcarcell (PR#368)

  • Use PROJECT_BINARY_DIR instead of CMAKE_BINARY_DIR to always locate the test files

• 2024-09-16 jmcarcell (PR#366)

  • Remove comments in edm4hep.yaml that don't add any information

• 2024-09-16 Mateusz Jakub Fila (PR#363)

  • Added missing attributes for python package

• 2024-09-16 tmadlener (PR#361)

  • Refactor createEDM4hepFile.py script to facilitate testing. Apart from the obviously different values in the objects, the overall structure is almost unchanged for the output file.
    • The MCVertexRecoParticleLinkCollection has been renamed to the VertexRecoParticleLinkCollection
    • The subdetectorHoleNumbers are also populated for Tracks.

• 2024-09-16 Mateusz Jakub Fila (PR#290)

  • Added loading pythonizations from podio

• 2024-09-13 tmadlener (PR#362)

  • Inject the EDM4hep version into the metadata that are stored by podio

• 2024-09-10 jmcarcell (PR#359)

  • Use the Key4hepConfig flag to set the standard, compiler flags and rpath magic.
  • For EDM4hep, the standard keeps being C++20 and the rpath is set as it was before. For the compiler flags -Wshadow is added on top of the existing ones.

• 2024-09-09 tmadlener (PR#360)

  • CI: Update versions of github actions where appropriate
  • CI: simplify workflows that build podio and EDM4hep by using cmake commands to invoke the build tool
  • CI: Enable more features from podio for building EDM4hep on top of
    • Also fix a buggy printout that states the commit of podio that was used for building

• 2024-09-04 Mateusz Jakub Fila (PR#357)

  • Fixed typos in member assignment in createEDM4hep.py

• 2024-09-02 Mateusz Jakub Fila (PR#354)

  • Removed C++17 compatibility in version header file

• 2024-09-02 jmcarcell (PR#353)

  • Create a RNTuple EDM4hep file (needs podio with RNTuple, if not present the test will be skipped)
  • Make the createED4MhepFile.py accept an argument for the output file name
  • Add explanations in the README on how to obtain the files.
  • Fix a few issues like #355 and #356 with the script.

• 2024-08-27 jmcarcell (PR#343)

  • Move to C++20 and remove vector_utils_legacy

• 2024-08-09 jmcarcell (PR#342)

  • Drop support for the ROOTLegacyReader when converting to JSON

• 2024-08-08 jmcarcell (PR#351)

  • Remove a few unnecessary includes

v00-99

v00-99 (v01-00 pre-release)

This is a pre-release for the first stable release of EDM4hep. We consider the datatypes that are currently in to be well defined (enough) so that no major changes to the existing datatypes are foreseen in the midterm future. For any potential changes we think that they can be transparently handled by the available schema evolution facilities. We will probably make a few smaller fixes and remove still existing deprecated functionality as well as add more documentation before we plan to release v01-00 in a few weeks.

Note

There have been many breaking changes in the definition of the datatypes in EDM4hep. Hence files written with an earlier version of EDM4hep are almost certainly not readable with this version.

Changes wrt v00-10-05

• 2024-07-31 tmadlener (PR#349)

  • Update the Link names in the diagram after #341

• 2024-07-30 tmadlener (PR#350)

  • Include the user handle types in the Collection.h legacy header files such that they can truly be used transparently.

• 2024-07-30 tmadlener (PR#348)

  • CI: Make sure to use the python bindings of podio that we build in CI

• 2024-07-30 jmcarcell (PR#347)

  • Covariance matrices: Check for the size of the input for one of the constructors
    • static_cast the inputs to float

• 2024-07-30 tmadlener (PR#345)

  • Bump the schema version of EDM4hep to 2 to have a way to differentiate between before pre-release and afterwards

• 2024-07-30 tmadlener (PR#341)

  • Rename the members of the associations to from and to in preparation for a transparent introduction of templated associations in podio (AIDASoft/podio#257)
    • Add (immediately deprecated) compatibility getters and setters that keep the current behavior on the API side.
  • Rename Association to Link and make naming more consistent
    • Add (immediately deprecated) compatiblity typedefs and headers to keep the current behavior.

• 2024-07-30 Federico Meloni (PR#337)

  • edm4hep::Track: Added Nholes and subdetectorHoleNumbers

• 2024-07-29 jmcarcell (PR#346)

  • Update LCG workflow to use LCG_106 instead of LCG_104

• 2024-07-28 jmcarcell (PR#272)

  • Add a script to create an EDM4hep file. The script is in python and can be called like python createEDM4hepFile.py. I have tried to make use of every member and relation in the data model. The purpose is to have something that can create quickly an EDM4hep file and because the script is in python no compilation is needed, hopefully lowering the barrier to get to an EDM4hep file. People can adapt it to their needs or use it as an example for testing, debugging, etc.

• 2024-07-19 tmadlener (PR#332)

  • Make the Vertex have relations to the (decay) particles that were used to build it
  • Rename the ReconstructedParticle relation to a Vertex to decayVertex (as dicsussed in #320)

• 2024-07-16 tmadlener (PR#340)

  • Improve the error message of the README links CI check to suggest how to fix it

• 2024-07-16 tmadlener (PR#311)

  • Remove the dQ/dx information from the Track
  • Add TrackPIDHandler to allow for the reverse lookup

• 2024-07-10 jmcarcell (PR#339)

  • Load libraries without the .so suffix to make it work in other OSes

• 2024-07-08 tmadlener (PR#336)

  • Switch to EL9 as OS for the dev4 stack based CI workflow

• 2024-07-08 tmadlener (PR#329)

  • Rename the Vertex primary field to type and make it a 32 bit unsigned integer
  • Introduce 3 reserved bits and accompanying utility / ExtraCode functionality for checking primary, secondary or tertiary vertex
  • Introduce setBit and checkBit utility functionality and also use that for the MCParticle extra code

• 2024-07-08 jmcarcell (PR#326)

  • Remove radiusOfInnermostHit from tracks

• 2024-07-04 tmadlener (PR#334)

  • Remove compatibility with podio versions before 1.0

• 2024-06-28 tmadlener (PR#335)

  • Remove the association between TrackerHitPlane and SimTrackerHit from the diagram

• 2024-06-28 tmadlener (PR#333)

  • Remove some of the drift chamber study types that were introduced in #179 again since they need a bit more consideration
    • The removed types and components are: Hypothesis, HitLevelData, RecIonizationCluster, SimPrimaryIonizationCluster, TrackerPulse
    • Keep the types and components that are already in use, mainly TimeSeries
  • Remove the usage of the removed components from RecDqdx to make it a purely reconstruction level type
  • Fix script that checks that all types are part of the json dumper

• 2024-06-28 tmadlener (PR#331)

  • Remove the MCRecoTrackerHitPlaneAssociation as it is no longer necessary

• 2024-06-28 jmcarcell (PR#324)

  • Change probability to ndf in Vertex

• 2024-06-27 tmadlener (PR#330)

  • Remove docstring of Track::type that is no longer relevant for EDM4hep and was a leftover from LCIO.
    • EDM4hep does not (yet) reserve any bits in the Track

• 2024-06-25 Wouter Deconinck (PR#327)

  • Require podio 1.0

• 2024-06-24 Thomas Madlener (PR#325)

  • Introduce a edm4hep::labels::MCParticles label to formalize the name of the canonical MCParticle collection

• 2024-06-18 Benedikt Hegner (PR#310)

  • Add GeneratorEventParameters and GeneratorPdfInfo datatypes to store generator related data in a structured and well defined way.
  • Add a GeneratorToolInfo struct and related utility functionality to store some high level metadata on the generator into Frame parameters.

• 2024-06-17 tmadlener (PR#315)

  • Introduce the edm4hep::labels namespace to hold the string constants that are used for consistent labeling / naming of collections or parameters.
    • Use this opportunity to homogenize the naming and capitalization of the variables but leave string constants unchanged
  • Deprecate existing string constants

• 2024-06-12 tmadlener (PR#314)

  • Make the python bindings install prefix conform to python conventions by default and allow overriding with the EDM4HEP_PYTHON_INSTALLDIR cmake variable
    • Default prefix is now <prefix>/lib[64]/pythonX.Y/site-packages (where lib or lib64 is defined from the platform defaults and X.Y is the python major and minor version).

• 2024-06-11 tmadlener (PR#313)

  • Switch to alma9 image to fix documentation deploys

• 2024-06-11 tmadlener (PR#307)

  • To have a more consistent way of filling the algoType in the edm4hep::utils::ParticleIDMeta use the 32 bit version of MurmurHash3 to hash the algoName to get to algoType. Fixes #298
    • Make algoType a private member but allow read access to it via the algoType member function. algoType has to be filled on construction. It is still possible to set it manually, the hashing will only kick in for the constructor taking only a name.

• 2024-06-11 Juraj Smiesko (PR#283)

  • Adding metadata name for event filter statistics.

• 2024-06-04 tmadlener (PR#303)

  • Update the schema diagram to reflect the changes from #268

• 2024-06-03 Mateusz Jakub Fila (PR#308)

  • Use declarationFile instead of include in CovMatrix to fix generated documentation for covariance matrix components. Fixes #296

• 2024-05-21 tmadlener (PR#302)

  • Update the schema diagram to reflect the TrackerHit as interface
    • Add TrackerHit3D as new type
  • Fix all arrow heads to be consistently black

• 2024-05-16 tmadlener (PR#305)

  • Introduce pre-processor checks to transparently switch to the new std::optional return values of podio::Frame::getParameter (introduced with AIDASoft/podio#580)

• 2024-05-14 jmcarcell (PR#304)

  • Remove ParticleID that was deleted in #268 and reintroduced in #287

• 2024-05-07 Andre Sailer (PR#300)

  • DOC: change association descriptions to allow doxygen to link to respective classes

• 2024-05-02 Mateusz Jakub Fila (PR#297)
  ...

v00-10-05

v00-10-05

• 2024-02-07 Thomas Madlener (PR#266)

  • Revert making MCParticle momenta double precision, since this breaks without schema evolution. (Reverts #237)
    • All particle momenta are effectively zeroed out at the moment.

• 2024-02-07 jmcarcell (PR#264)

  • Delete build workflow since we have another one for key4hep that covers builds for nightlies, releases and all the operating systems we support

• 2024-02-06 jmcarcell (PR#263)

  • Change ROOTFrame{Writer,Reader} to ROOT{Writer,Reader} following AIDASoft/podio#549

v00-10-04

v00-10-04

Caution

The changes introduced in PR#237 are not backward compatible and reading existing files will silently zero out MCParticle momenta read from disk! This release should not be used!

• 2024-01-30 tmadlener (PR#258)

  • Bump the version in the schema diagram to v0.10

• 2024-01-23 tmadlener (PR#237)

  • Switch the momentum and momentumAtEndpoint of the MCParticle from Vector3f to Vector3d.
  • Add a (deprecated from the beginning) constructor from Vector3f to Vector3d to ease the transition.

• 2024-01-22 tmadlener (PR#253)

  • Fix she-bang in README links update script.

• 2024-01-12 Mateusz Jakub Fila (PR#250)

  • Fixed doxygen excluded files and path stripping

• 2024-01-08 Mateusz Jakub Fila (PR#249)

  • Fixed formatting of components table in readme

v00-10-03

v00-10-03

• 2024-01-08 Joe Osborn (PR#248)

  • Added a Vector4f object for use as a general 4 dimensional vector with members x, y, z and t. Fixes #245

• 2023-12-12 Mateusz Jakub Fila (PR#244)

  • Fixed typos and links in documentation and doxygen

• 2023-12-06 tmadlener (PR#243)

  • Make sure that tests also work in Ubuntu 20.04 environments by running catch test discovery in correct environment.

• 2023-12-05 jmcarcell (PR#235)

  • Use FILE_SET to install the headers in the top folder together with the library. This also adds them in the BUILD_INTERFACE, something that a simple INSTALL doesn't do.
  • Bump the CMake version of the LCG stacks
  • Simplify finding ROOT, don't do environment variable manipulation in CMake

v00-10-02

v00-10-02

• 2023-11-14 jmcarcell (PR#240)

  • Change EventHeader to EventHeaderName; we already have an EventHeaderCollection and its elements are called EventHeader (edm4hep::EventHeader more precisely)

• 2023-11-14 Leonhard Reichenbach (PR#239)

  • Add a constant for the default expected EventHeader name to be used by the converters and PodioInput

v00-10-01

v00-10-01

• 2023-11-01 jmcarcell (PR#234)

  • Add a constant for CellIDEncoding. Usage:

  #include "edm4hep/Constants.h"
  
  std::cout << edm4hep::CellIDEncoding << std::endl;

• 2023-11-01 Juraj Smiesko (PR#227)

  • edm4hep2json now converts all EDM4hep collections, associations and Podio user data
  • added ROOT legacy support for edm4hep2json

• 2023-09-13 jmcarcell (PR#226)

  • Rename the cmake executable or target unittests to unittests_edm4hep, to avoid possible collisions since the unittests name is relatively common

• 2023-09-11 Wouter Deconinck (PR#225)

  • Define schema_version at top level in yaml file

• 2023-09-11 tmadlener (PR#224)

  • Add SKIP_CATCH_DISCOVERY option to turn of catch_discover_tests which may not run in the right environment in older cmake versions.

• 2023-09-05 Andre Sailer (PR#223)

  • CI: use same lcg stacks as podio
  • Test: update to Catch2 3.4.0, same as in podio, and c++20 compatible

• 2023-09-05 jmcarcell (PR#222)

  • Remove init.sh

v00-10

v00-10

• 2023-07-07 BrieucF (PR#212)

  • Add a script to automatically update the README.md links

• 2023-07-04 tmadlener (PR#209)

  • Add brief documentation of the edm4hep2json tool with minimal documentation of the output JSON schema.

• 2023-06-30 jmcarcell (PR#207)

  • Improve python API, use import edm4hep instead of from edm4hep import edm4hep

• 2023-06-29 tmadlener (PR#206)

  • Replace TPCHit with RawTimeSeries
  • Update version to 0.9
  • Add TrackerPulse

• 2023-06-14 jmcarcell (PR#204)

  • Add python bindings for the datamodel classes and some documentation on how to use the bindings

• 2023-06-07 FinnJohannsen (PR#188)

  • Changed the name of one VectorMember of edm4hep::track from subDetectorHitNumbers to subdetectorHitNumbers to be consistent with other spellings of the word subdetector in the yaml file and in LCIO.