.. pyUSID documentation master file, created by
   sphinx-quickstart on Fri Jun 22 08:12:01 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to pyUSID's documentation!
==================================
**Framework for storing, visualizing, and processing Universal Spectroscopic and Imaging Data (USID)**

Jump to our `GitHub project page <https://github.com/pycroscopy/pyUSID>`_

.. toctree::
   :glob:
   :maxdepth: 1
   :caption: pyUSID

   about
   install
   faq
   contact
   credits
   scale_to_hpc

Source code API
---------------
.. autosummary::
   :toctree: _autosummary
   :template: custom-module-template.rst
   :recursive:

   pyUSID

* :ref:`modindex`

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

   notebooks/**/index