README.md

Live Data Reduction Documentation

This directory contains comprehensive documentation for the livereduce system, which provides real-time data processing for neutron scattering instruments.

┌──────────────────────────────────────────────────────────────────┐
│                   Documentation Structure                        │
└──────────────────────────────────────────────────────────────────┘

For Understanding
    └── Architecture ──────→ System design and data flow

For Setting Up
    ├── Developer Guide ───→ Installing daemon on servers
    ├── Processing Scripts → Writing reduction scripts
    └── Configuration ─────→ Parameter reference

For Problems
    └── Troubleshooting ───→ Debugging and fixes

For Contributing
    ├── Examples ──────────→ Integration patterns
    └── CONTRIBUTING.md ───→ Development workflow

Documentation Structure

For Developers

• Architecture - System components, data flow, and design overview
• Developer Guide - Setting up live reduction for a beamline
• Processing Scripts - Creating and deploying processing scripts
• Configuration Reference - Complete configuration options reference
• Examples - Integration examples and patterns

For Operations

• Troubleshooting - Debugging, common issues, and service management

For Contributors

• Contributing Guide - Development workflow and guidelines

Quick Links

I want to...

• Set up live reduction for my beamline: See Developer Guide
• Write processing scripts: See Processing Scripts
• Integrate with existing workflows: See Examples
• Fix a problem: See Troubleshooting
• Understand the system: See Architecture
• Configure the daemon: See Configuration Reference
• Contribute to the project: See Contributing Guide

Overview

Live reduction provides real-time data processing as the Data Acquisition System (DAS) collects neutron scattering data. Scientists can monitor results and adjust experimental parameters without waiting for runs to complete.

The livereduce systemd service provides automated processing for beamline operations. For interactive usage of live data in Mantid Workbench, see the Mantid StartLiveData documentation.

Additional Resources

• Main README - Installation and basic usage
• Mantid StartLiveData documentation
• livereduce GitHub repository
• Test examples