.. USID documentation master file, created by
   sphinx-quickstart on Wed Jun 27 10:37:14 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to USID documentation!
==============================
**Motivaton, specifications, implementation, and guidelines for the Universal Spectroscopic and Imaging Data (USID) model**

.. attention::

    If your data has a clear N-dimensional form, consider using
    `NSID <https://pycroscopy.github.io/pyNSID/nsid.html>`_ and
    `pyNSID <https://pycroscopy.github.io/pyNSID/about.html>`_
    as simpler and more user-friendly alternatives to USID and pyUSID.

Site index
----------
.. toctree::
   :glob:
   :maxdepth: 1
   :caption: USID

   about
   motivation
   nomenclature
   usid_model
   file_format
   h5_usid
   metadata
   advanced_topics
   faq

* :ref:`modindex`

.. toctree::
   :glob:
   :maxdepth: 2
   :caption: Examples

   notebooks/**/index