Welcome to pydirectional's documentation!
=========================================================

*pydirectional* is a Python package for all things BRDF (bidirectional reflectance distribution function) related! It allows forward modelling using
a range of BRDF models, handling of BRDF data, and analysing this data.

.. grid:: 2
    :gutter: 2

    .. grid-item-card::  Getting Started
        :link: content/getting_started
        :link-type: doc

        New to *pydirectional*? Check out the getting started guides. They contain installation instructions.

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

        The user guide provides in-depth information on how to use the forward models, data containers, and helper classes in *pydirectional*.

    .. grid-item-card::  Theory
        :link: content/theory/index
        :link-type: doc

        The theory section provides a mathematical basis to BRDF and other related concepts, and a description of the forward models included in *pydirectional*.

    .. grid-item-card::  API reference
        :link: content/api
        :link-type: doc

        The reference guide contains a detailed description of the *pydirectional* API.
        The reference describes how the methods work and which parameters can
        be used. It assumes that you have an understanding of the key concepts.

.. toctree::
   :maxdepth: 1
   :caption: For users:
   :hidden:

   Getting Started <content/getting_started>
   User Guide <content/user_guide/index>
   Theory <content/theory/index>
   API Reference <content/api>