# 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.

:::{toctree}
:maxdepth: 2
:caption: Guides

getting-started
usage
nexus-description-syntax
cli
tests
architecture
plugins
schema-placer
whats-new
:::

## Source Code

The project lives at [HZB/ICAT-connect/NeXusCreator](https://github.com/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).