SED documentation

SED (Single Event Data Frame) is a collection of routines and utilities to handle photoelectron resolved datastreams. It features lazy evaluation of dataframe processing using dask, numba-accelerated multi-dimensional binning, calibration and correction for trARPES (Time- and angle-resolved photoemission spectroscopy) datasets. The package ensures provenance and FAIR data through metadata tracking, usage of the community defined NeXus format.

User guide

We introduce different functionalities of the package by several step-by-step use guides:

• User Guide
  • Installing SED
  • Basic concepts
  • Advanced Topics

Examples

Several example notebooks to demonstrate the functionality of SED for end-to-end data analysis workflows.

• Workflows
  • Tutorial for binning data from the HEXTOF instrument at FLASH
  • Tutorial for binning data from the SXP instrument at the European XFEL
  • Tutorial for trXPD for the HEXTOF instrument at FLASH with background normalization

API

• API
  • Core
  • Dataframe Operations
  • Data loader
  • Binning
  • Calibrator
  • Dataset
  • Diagnostics
  • IO
  • Metadata
  • Config

Community and contribution guide

Information about the community behind this theme and how you can contribute.

• Development
  • Contributing to sed
  • How to Maintain