.. _user_guide:

==========
User Guide
==========

.. toctree::
   :hidden:
   :caption: Tutorials

   quick_start
   about

.. toctree::
   :hidden:
   :caption: How-to Guides

   howto/index

.. toctree::
   :hidden:
   :caption: Reference

   geometries/index
   reference/declarative_geometry_schema
   api
   glossary
   references

.. toctree::
   :hidden:
   :caption: Explanation

   concepts
   direct-lattice
   problem1
   problem2

.. icons: https://fonts.google.com/icons

.. grid:: 2

   .. grid-item-card:: :material-outlined:`school;3em` Tutorials

      - :doc:`Build new geometry <quick_start>`
        · :ref:`Use Demo Geometry <quick-start-demo>`

      - :ref:`Project Overview <about>`

   .. grid-item-card:: :material-outlined:`directions_run;3em` How-to Guides

      :doc:`Overview <howto/index>`
      · :ref:`set wavelength <howto-wavelength>`
      · :ref:`define a lattice <howto-lattice>`
      · :ref:`orient a crystal <howto-orient>`
      · :ref:`solve the forward problem <howto-forward>`
      · :ref:`switch modes <howto-modes>`
      · :ref:`plan trajectories <howto-trajectory>`
      · :doc:`align a crystal end-to-end <howto/fourcv_alignment_howto>`

   .. grid-item-card:: :material-outlined:`library_books;3em` References

      :ref:`Demo Geometries <geometries>`
      · :ref:`Declarative Geometry Schema <declarative-geometry-schema>`
      · :doc:`API Reference <api>`
      · :ref:`Glossary <glossary>`
      · :ref:`Literature References <references>`

   .. grid-item-card:: :material-outlined:`psychology;3em` Explanation

      - :doc:`Concepts <concepts>`
        · :doc:`Direct Lattice <direct-lattice>`

      - **Case Studies**: :doc:`Describing a Diffractometer <problem1>`
        · :doc:`Choice of Basis and the UB Matrix <problem2>`