Welcome to PODIO’s documentation!

• Introduction
• Quick-start
• Design and Implementation Details
  • Layout of Objects
  • Handling mutability
• Data Models and Data Model Definitions
  • Basic Concepts and Supported Features
  • Mandatory fields
  • Definition of custom components
  • Definition of custom data classes
  • Definition of custom interfaces
  • Definition of links
  • Global options
  • Embedding a datamodel version
  • Extending a datamodel / using types from an upstream datamodel
• Examples for Supported Interface
  • Object Ownership
  • Object Creation and Storage
  • Object References
  • Subset collections
  • Looping through Collections
  • Constructing Collections from Ranges
  • Cloning objects
  • Support for Notebook-Pattern
  • podio::Frame container
  • Object Retrieval
  • User defined Meta Data
  • Python Interface
• Reading and writing podio files
  • C++
  • Python
• The Frame concept
  • Basic functionality of a Frame
  • I/O basics and philosophy
• Frame implementation and design
• Writing extra data outside the EDM
  • Example usage
  • Some limitations
• Linking unrelated objects with each other
  • Link basics
  • How to use Links
  • The LinkNavigator utility
  • Implementation details
• Storage details of files produced by podio
  • ROOT
  • SIO
  • Arrow/Parquet
• Tools and utilities
  • Displaying the content of files: podio-dump
  • Merging files: podio-merge-files
  • Converting between ROOT TTrees and RNTuples: podio-ttree-to-rntuple
  • Visualizing a model: podio-vis
  • Testing hash collisions in collection names: podio-test-hashes
• Building a new data model library with CMake
  • Exported CMake functions and macros
  • A simple example
  • More advanced data model generation
  • Example usage of Advanced options
• Advanced Topics
  • Writing extra data outside the EDM
  • Changing / creating new templates
  • Persistency
  • Thread-safety
  • Schema evolution
  • Running pre-commit
  • Retrieving the EDM definition from a data file
  • Subset collections
• Changing / creating new templates
  • Preprocessing of yaml file
  • Existing templates
  • Adding a new template
  • Available information in the templates
• Python interface for data models
  • Pythonizations
• PODIO Collection as a Container
  • Container Types
  • Container member functions and operators
  • Collection as an AllocatorAwareContainer
  • Collection iterators as an Iterator
  • Collection iterators and standard iterator adaptors
  • Collection as a range
  • Collection and standard algorithms
  • Collection and standard range algorithms
  • Iterator invalidation
• C++ API documentation
  • Class list
  • Struct list
  • Namespace list
• python
  • podio package
  • podio_class_generator module
  • podio_gen package
  • podio_schema_evolution module