Skip to main content
Ctrl+K

MoDaCor 1.11.0 documentation

  • Introduction
  • Getting started
  • Data model
  • Processing framework
  • Modules
    • Client-server operation
    • Examples
    • Reference
    • Development
    • Project information
  • GitHub
  • Introduction
  • Getting started
  • Data model
  • Processing framework
  • Modules
  • Client-server operation
  • Examples
  • Reference
  • Development
  • Project information
  • GitHub

Table of Contents

Learn and use

  • Introduction
  • Getting started
  • Data model
  • Processing framework
  • Modules
  • Client-server operation
  • Examples
  • Reference
    • Process-step reference
    • Python API
    • Command-line reference
    • Pipeline configuration reference
    • I/O capability reference
    • Runtime service API reference
    • Glossary
  • Development

Project

  • Project information
Show Source
  • Reference

Reference#

Exact interfaces, schemas, commands, and generated process-step metadata.

  • Process-step reference
    • Data movement and copying
    • Arithmetic and normalization
    • Masks
    • Uncertainty creation and combination
    • Geometry and coordinates
    • Reduction and integration
    • Visualization
    • Technique-specific corrections
    • Alphabetical index
  • Python API
    • Data-model API
    • Pipeline and runner API
    • I/O API
    • Runtime client API
  • Command-line reference
    • modacor run
    • modacor serve
    • modacor session
  • Pipeline configuration reference
    • Step fields
    • Repeated step blocks
    • Step configuration validation
    • DataBundle arithmetic
    • Sampled-data integration
    • NeXus detector frames
    • Threshold masks
  • I/O capability reference
    • Sources
    • Sinks
  • Runtime service API reference
    • Current implementation status
    • Goals
    • Core concepts
    • PipelineSession
    • Source registry model
    • Sink registry model
    • Reset modes
    • State machine
    • Partial invalidation contract
    • API schema (REST)
    • Service status
    • Sessions
    • Sources
    • Sinks
    • Chunked outputs
    • Processing
    • Runs
    • Runtime Policy
    • WebSocket events
    • Error model
    • Concurrency and consistency contracts
    • Bluesky integration notes
    • Quick use example
  • Glossary

The downloadable OpenAPI document describes the runtime HTTP schema.

previous

Remote server operation

next

Process-step reference

Show Source

© Copyright 2025-2026, Brian R. Pauw, Malte Storm, Jérôme Kieffer, Ingo Breßler, Anja Hörmann, Glen Smales, Armin Moser, and Tim Snow.

Created using Sphinx 9.1.0.

Built with the PyData Sphinx Theme 0.22.0.