nyaml documentation

The nyaml tool offers a user-friendly command-line interface for converting between XML and YAML representations of NeXus definitions written in the NeXus Definition Language (NXDL). While the official NeXus definitions are maintained in XML, authoring them in YAML provides a more concise and readable alternative. nyaml bridges this gap, allowing developers to work in YAML while ensuring compatibility with the official XML format.

The tool supports both NeXus application definitions and base classes. It can be installed via pip and includes comprehensive documentation and tutorials to assist users in writing NeXus definitions using YAML.

Tutorials

Step-by-step guides for installing nyaml and writing NeXus definitions in YAML

• Installation
• Writing a NeXus definition in YAML
• Contributing

How-to guides

How to install and use the nyaml tool

• Getting started with nyaml

Learn

An introduction to NeXus and its use in the light of YAML format using the nyaml tool.

• Introduction to NeXus
• Motivation behind the nyaml tool
• Workflow of the nyaml tool with examples
• nyaml notation reference

References

The list of references used in this documentation

• CLI API
• References

Contact

For questions or suggestions:

• Open an issue on the nyaml GitHub
• Join our Discord channel
• Get in contact with our lead developers.

Project and community

The work is funded by the Deutsche Forschungsgemeinschaft (DFG, German Research Foundation) - 460197019 (FAIRmat).