=====================
pyxem's Documentation
=====================

Pyxem is an open-source project working to bring together tools for the analysis of electron diffraction data, in
particular data acquired from pixelated electron detectors. With its roots in the HyperSpy community, pyxem has an
active community of users and developers who are working to provide advanced and state-of-the art tools for the
analysis of 4-D, 5-D STEM and other pixelated electron detector data.

.. grid:: 2 3 3 3
  :gutter: 2

  .. grid-item-card::
    :link: user_guide/installing
    :link-type: doc

    :octicon:`rocket;2em;sd-text-info` Getting Started
    ^^^

    New to pyxem or Python? The getting started guide provides an
    introduction on basic usage of HyperSpy and how to install it.

  .. grid-item-card::
    :link: user_guide/index
    :link-type: doc

    :octicon:`book;2em;sd-text-info` User Guide
    ^^^

    The user guide provides in-depth information on key concepts of pyxem
    and how to use it along with background information and explanations.

  .. grid-item-card::
    :link: reference/index
    :link-type: doc

    :octicon:`code-square;2em;sd-text-info` Reference
    ^^^

    Documentation of the metadata specification and of the Application Programming Interface (API),
    which describe how pyxem functions work and which parameters can be used.

  .. grid-item-card::
    :link: examples/index
    :link-type: doc

    :octicon:`zap;2em;sd-text-info` Examples
    ^^^

    Gallery of short examples illustrating simple tasks that can be performed with pyxem.

  .. grid-item-card::
    :link: tutorials/index
    :link-type: doc

    :octicon:`workflow;2em;sd-text-info` Tutorials
    ^^^

    Tutorials in form of Jupyter Notebooks which show full workflows for specific tasks.

  .. grid-item-card::
    :link: dev_guide/index
    :link-type: doc

    :octicon:`people;2em;sd-text-info` Developer Guide
    ^^^

    pyxem is an open-source project and we welcome contributions of all kinds!