=======================================
User Manual and Reference Documentation
=======================================

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

https://www.nexusformat.org/

.. toctree::
    :maxdepth: 2
    :numbered: 5

    fairmat-cover
    nexus-index
    em-structure
    mpes-structure
    optical-spectroscopy-structure
    apm-structure
    transport-structure
    spm-structure
    cgms-structure
    north-structure
    napi
    history




-----------

.. rubric:: Publishing Information

| This commit time code |commit_time|.
| This commit identifier |commit_hash|.
| This manual built |today|.

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.

.. rubric:: Acknowledgements

| The FAIRmat project is funded by the Deutsche Forschungsgemeinschaft
| (`DFG <https://www.dfg.de/en/index.jsp>`_, German Research Foundation) - project 460197019.
| FAIRmat is a consortium within the `German NFDI <https://www.nfdi.de/?lang=en>`_.


.. seealso:: 

   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/>`_