MoDaCor documentation

MoDaCor provides reference-quality, traceable corrections for monochromatic X-ray and neutron scattering, diffraction, and imaging, with explicit physical units and multiple named uncertainty contributions.

Choose a route

• First run: install MoDaCor and complete the synthetic Quickstart.

• Pipeline author: start with the data model, then learn the processing framework.

• Existing pipeline author: review the breaking interface migrations before running older YAML with the current release.

• Facility or service operator: read the client-server architecture and installation guidance.

• Contributor: use the development guides and current design records.

Learn and use

• Introduction
  • Purpose and scope
  • Scientific principles
  • Terminology
• Getting started
  • Installation
  • Quickstart
  • Where to go next
• Data model
  • BaseData
  • DataBundle
  • ProcessingData
  • Units and dimensionality
  • Uncertainty propagation
  • Paths, axes, weights, and masks
• Processing framework
  • Process steps
  • Pipeline graphs
  • Pipeline configuration
  • Breaking pipeline interface changes
  • I/O sources
  • I/O sinks
  • Local execution
  • Dependencies and partial reruns
  • Tracing and debugging
  • Chunked processing
• Modules
  • Choosing modules
  • Masking
  • Uncertainty workflows
  • Arithmetic and normalization
  • Geometry
  • Integration and reduction
  • Scattering corrections
  • Capillary sample self-absorption correction
• Client-server operation
  • Client-server architecture
  • Server installation
  • Clients and sessions
  • Server operations
  • Buffers and chunked outputs
  • Live output and plots
  • Advanced server use
  • Security and runtime policy
• Examples
  • Local operation
  • Remote server operation
  • Instrument examples
• Reference
  • Process-step reference
  • Python API
  • Command-line reference
  • Pipeline configuration reference
  • I/O capability reference
  • Runtime service API reference
  • Glossary
• Development
  • Contributing
  • Development principles
  • Package architecture
  • Software guidelines
  • Module author guide
  • IO source and sink extension
  • Contribution checklist
  • Documentation contributor guide
  • Testing and release
  • Design Notes

Project

• Project information

Indices

• Index

• Module Index

• Search Page