NeXusCreator

Build and convert NeXus files rapidly using a plugin-based workflow. NeXusCreator lets you generate NeXus definitions (.nxd/YAML) from raw data, enrich them with metadata, and produce validated NeXus HDF5 outputs that fit beamline requirements.

Whether you are interested in the CLI, the Python API, or extending the tool with custom plugins, this documentation is organised to get you moving quickly.

Guides

• Getting Started
  • Installation
  • Generate a NeXus Definition (.nxd/YAML)
  • Convert to NeXus HDF5 (.nxs)
  • Placement and Metadata (Optional)
• Usage Guide
  • Installation Recap
  • Choose Options by Relevance
  • Generate a NeXus Definition
  • Convert to NeXus HDF5
  • Batteries Electrochemical Analysis
  • MPES Workflow
  • Directory Scans and Batch Processing
  • Placement Controls and Metadata
  • Prompt Literals
  • Validate Outputs
  • Export Dataset Values to CSV
  • Links in .nxd and YAML
  • Python API (Advanced)
  • CLI Reference (Grouped)
• NeXus Description Syntax
  • File Basics
  • Groups
  • Attributes
  • Datasets
  • Value Handling
  • Prompt Literals
  • Internal Links
  • External Links
  • Placeholder Expansion
  • Scan Templates
  • YAML Shape
  • Minimal Complete .nxd Example
  • Creating a nexus_object Programmatically
  • Detailed .nxd File Format
• CLI Reference
  • Always Relevant (Any Run)
  • Relevant When Converting to .nxs (-n)
  • Relevant When Generating Definitions (-g)
  • Relevant for Directory / Batch Inputs
  • Relevant for Metadata / Schema-Guided Placement
  • Relevant for Validation / CSV Export Workflows
• Test Suite
  • Quick Start
  • Common Environment Issue
  • Test File Inventory (tests/)
  • External Reference Test Suites
  • Tips for Contributors
  • testing_area .nxd Commands
• Architecture
  • Components
  • Data Flow
  • External Links for SPEC Per-Scan Outputs
  • Output Path Rules
  • Parser and Generator System
  • Plugin Overview
• Plugin System
  • Built-in Plugins
  • Parser and Generator System
  • How Discovery Works
  • Create Your Own Plugin
  • Minimal Example
• SchemaPlacer
  • Capabilities
  • Quick Example
  • Tips
  • Inspecting candidates
• What’s New
  • Schema & Placement
  • HDF5 & Templates
  • Inputs & Plugins
  • CLI & Batch

Source Code

The project lives at HZB/ICAT-connect/NeXusCreator. You can install it from a clone with python3 -m pip install . or work on it in editable mode via pip install -e .[dev] (requires the optional developer dependencies).