.. _user-guide:

******************
Wulfric user guide
******************

Installations and version
=========================
.. toctree::
    :maxdepth: 1

    installation
    development

Definitions and conventions
===========================
.. toctree::
    :maxdepth: 1

    conventions/basic-notation
    conventions/which-cell
    conventions/bravais-lattices/index

.. _user-guide_fundamentals:

Fundamentals and usage
======================
.. toctree::
    :maxdepth: 2

    usage/package-structure
    usage/key-concepts
    usage/cell
    usage/kpoints
    usage/crystal
    usage/other
    usage/io
    usage/visualization

.. _user-guide_library:

Methods and algorithms
======================
.. toctree::
    :maxdepth: 1

    library/lepage
    library/niggli