Welcome to the FAIRmat NeXus documentation¶
Within FAIRmat, we are extending the NeXus data format standard to support the FAIR principles for experimental data in materials science.
This documentation covers our contributions to the NeXus standard, and our supporting software tool, pynxtools
. pynxtools
maps data and metadata from diverse instruments and electronic lab notebooks (ELNs) into NeXus-compliant HDF5 files. It supports parsing, normalization, visualization, and ontology matching.
pynxtools
offers scientists a convenient way to use the NeXus format and solves the challenge of unstructured and non-standardized data in experimental materials science.
The software can also be used as a plugin in the research data management system NOMAD, an open-source platform for FAIR materials data management. Learn more in the NOMAD documentation.
We are offering a small guide to getting started with NeXus, pynxtools
, and NOMAD:
Tutorial¶
Reference¶
NeXus definitions¶
Here, you find the detailed list of application definitions and base classes and their respective fields.
pynxtools¶
pynxtools
has a number of command line tools that can be used to convert data and verify NeXus files. You can find more information about the API here.
Within FAIRmat, we maintain a number of generic built-in pynxtools readers, together with reader plugins for different experimental techniques. Here you can find more information:
Contact
For questions or suggestions:
- Open an issue on the
pynxtools
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).