PODIO
  • Introduction
  • Quick-start
  • Design and Implementation Details
    • Layout of Objects
      • The User Layer
      • The Internal Data Layer
      • The POD Layer
      • The Collections
      • Vectorization support / notebook pattern
    • Handling mutability
  • Data Models and Data Model Definitions
    • Basic Concepts and Supported Features
    • Definition of custom components
    • Definition of custom data classes
      • Defining members
      • Definition of references between objects:
      • Explicit definition of methods
    • Global options
    • Extending a datamodel / using types from an upstream datamodel
      • Potential pitfalls
  • Examples for Supported Interface
    • Object Ownership
    • Object Creation and Storage
    • Object References
    • Looping through Collections
    • Support for Notebook-Pattern
    • podio::Frame container
    • Object Retrieval
    • User defined Meta Data
      • Python Interface
  • The Frame concept
    • Basic functionality of a Frame
      • Usage examples for collection data
        • Putting collection data into the Frame
        • Getting collection (references) from the Frame
      • Usage for Parameters
    • I/O basics and philosophy
      • Writing a Frame
      • Reading a Frame
      • Schema evolution
  • Frame implementation and design
  • Writing extra data outside an EDM
    • Example usage
    • Some limitations
      • No relations to other collections
      • Limited supported types
  • Advanced Topics
    • Writing extra data outside the EDM
    • Changing / creating new templates
    • Persistency
      • Writing Back-End
      • Reading Back-End
      • Dumping JSON
    • Thread-safety
      • Changing user data
      • Serialization
      • Not-thread-safe components
    • Running pre-commit
    • Retrieving the EDM definition from a data file
      • Accessing the EDM definition programmatically
      • Technical details on EDM definition embedding
        • The DatamodelRegistry
        • I/O helpers for EDM definition storing
  • Changing / creating new templates
    • Preprocessing of yaml file
    • Existing templates
    • Adding a new template
    • Available information in the templates
      • General information
      • Components
      • Datatypes
      • MemberVariable
      • DataType
      • Julia code generation
PODIO
  • Search

© Copyright 2023, Key4hep authors.

Built with Sphinx using a theme provided by Read the Docs.
Other Versions v: v99-99-99
Versions
docs-on-gh-pages
master
v00-00-00
v00-99
v99-99-99