FAIRmat
Published May 12, 2026 | Version v1.0.2
Software Open

nyaml: Format Converter for the NeXus Data Model

Authors/Creators

Description

nyaml is a Python software tool designed for developers and users of the NeXus data exchange format (https://www.nexusformat.org/). The tool converts files that follow the NeXus Definition Language (NXDL) from XML to [YAML](https://yaml.org/), and vice versa. NXDL is used to define experiment instruments, setups, or scientific data objects from experiments in a schema-based structure. Writing NeXus data schemas via the indentation-based formatting of YAML offers a more concise writing and reduces common sources of formatting inconsistencies, while still adhering to NeXus standards. The tool requires users to follow a specific grammar for embedding NeXus data structures to ensure compatibility with NXDL (see the full documentation at https://fairmat-nfdi.github.io/nyaml/). The work is funded by the Deutsche Forschungsgemeinschaft (DFG, German Research Foundation) - 460197019 (FAIRmat) (https://gepris.dfg.de/gepris/projekt/460197019?language=en). Visit the [FAIRmat page](https://www.fairmat-nfdi.eu/fairmat/about-fairmat/consortium-fairmat) for more info.

Notes

If you use this software, please cite it using the metadata from this file.

Files

FAIRmat-NFDI/nyaml-v1.0.2.zip

Files (523.3 kB)

Name Size Download all
md5:a4d2dc3572784a77dda75d78a91d3ee9
523.3 kB Preview Download

Additional details

Related works

Is supplement to
Software: https://github.com/FAIRmat-NFDI/nyaml/tree/v1.0.2 (URL)

Software

Repository URL
https://github.com/FAIRmat-NFDI/nyaml