User Manual and Reference Documentation

Welcome to the user manual of the NeXus for FAIRmat project.

https://www.nexusformat.org/

• 1. FAIRmat-NeXus Proposal
  • 1.1. Aim
  • 1.2. Our scope and perspective
  • 1.3. Outreach to the community
  • 1.4. Which data should I convert?
• 2. NeXus Documentation
  • 2.1. NeXus: User Manual
  • 2.2. NeXus: Example data files I/O
  • 2.3. NeXus: Reference Documentation
  • 2.4. NeXus Community
  • 2.5. Installation
  • 2.6. NeXus Utilities
  • 2.7. About these docs
• 3. Electron microscopy
• 4. Photoemission & core-level spectroscopy
• 5. Optical spectroscopy
  • 5.1. Optical Spectroscopy
  • 5.2. Ellipsometry
  • 5.3. Raman spectroscopy
  • 5.4. Dispersive Material
• 6. Atom-probe tomography
• 7. Transport phenomena
• 8. Scanning Probe Microscopy
• 9. Geometry and microstructures
• 10. NOMAD OASIS Remote Tools Hub
  • 10.1. Introduction to NORTH
  • 10.2. apmtools container
• 11. Integrated Computational Materials Engineering
• 12. NAPI: NeXus Application Programmer Interface (frozen)
  • 12.1. Status
  • 12.2. Overview
  • 12.3. Core API
  • 12.4. Utility API
  • 12.5. Building Programs
  • 12.6. Reporting Bugs in the NeXus API
• 13. Brief history of NeXus

---

Publishing Information

This commit time code 2025-10-06 12:28:09 +0200.

This commit identifier 6cfc2d2e.

This manual built Oct 06, 2025.

Noteworthy, NeXus-FAIRmat works with a fork of the official NeXus definitions. Therefore, expect individual definitions may differ between versions when comparing the official NeXus repository and the fork maintained by FAIRmat. FAIRmat and NeXus exchange frequently to sync up such that the FAIRmat fork builds always on top of the latest official NeXus release.

Acknowledgements

The FAIRmat project is funded by the Deutsche Forschungsgemeinschaft

(DFG, German Research Foundation) - project 460197019.

FAIRmat is a consortium within the German NFDI.

See also

The extended NeXus documentation of the latest official NeXus release:

HTML:

https://manual.nexusformat.org/

PDF:

https://manual.nexusformat.org/_static/NeXusManual.pdf

A very brief overview (title: NeXus for the Impatient) is also available (separate from the manual).

HTML:

https://manual.nexusformat.org/impatient/

PDF:

https://manual.nexusformat.org/_static/NXImpatient.pdf

FAIRmat website:

https://www.fairmat-nfdi.eu/fairmat/about-fairmat/consortium-fairmat

NOMAD website:

https://nomad-lab.eu/