User Guide

km3pipe is built upon thepipe, a Python package which once was the core of km3pipe and has been split out as a separate package. It’s a generic pipeline framework which can be used in all kinds of modular workflow designs.

The km3pipe package is a collection of functions, classes and modules which are more or less specific to KM3NeT. It provides native Python access to all kinds of data formats like ROOT, EVT, binary DAQ, network protocols and more.

The preferred on-disk output file format is Storing Data (HDF5).

• Pipeline Workflow
  • Draining Procedure
  • Pipeline Example
  • Modules
  • Pumps / Sinks
  • Logging and Printing
  • Configuring the Pipeline using Configuration Files
• Data Structures
  • Hits and McHits
  • Calibrating Hits and McHits
  • Sorting of Hits
• Pipeline Features
  • Introduction
  • Ctrl+C for Graceful Exits
  • Time / Memory / CPU Usage
  • Services
  • Automatic HDF5 Writing
• Storing Data (HDF5)
  • Writing HDF5 Data
  • Data Hierarchy
  • (Experts) Data Substructure
• Command Line Tools
  • KM3Pipe
    • update
    • triggermap
  • DataBase
  • PipeInspector
  • HDF5 CLI Utils
    • h5info
    • h5extract
    • h5tree
    • ptdump (from PyTables)
    • pttree (from PyTables)
• Database access
• Local DB
  • Standalone
  • As a Service
• FAQ
  • Where is the tohdf5 command in KM3Pipe v9?