PedPy's documentation!
=================================

.. toctree::
   :maxdepth: 1
   :hidden:

   Getting started <getting_started>
   User Guide <user_guide/index>
   API reference <api/index>
   Contribution <dev/index>
   Disclaimer <disclaimer>


**Useful links**:
`Binary Installers <https://pypi.org/project/pedpy>`__ |
`Source Repository <https://github.com/PedestrianDynamics/pedpy>`__ |
`Issues & Ideas <https://github.com/PedestrianDynamics/pedpy/issues>`__

*PedPy* is an open source, MIT-licensed `Python <https://www.python.org/>`__ module for pedestrian movement analysis.
It implements different measurement methods for density, velocity and flow.

.. grid:: 4
    :gutter: 2

    .. grid-item-card:: Getting started
        :img-top: _static/getting_started.svg
        :link: getting_started
        :link-type: ref
        :link-alt: To the getting started guides

        New to *PedPy*? Check out the getting started guides. They contain an
        introduction to *PedPy*'s main concepts.

    .. grid-item-card:: User guide
        :img-top: _static/user_guide.svg
        :link: user_guide
        :link-type: ref
        :link-alt: To the getting started guides

        The user guide provides in-depth information on the
        key concepts of *PedPy* with useful background information and explanation.

    .. grid-item-card:: API reference
        :img-top: _static/api_reference.svg
        :link: api/index
        :link-type: doc
        :link-alt: To the reference guide

        The reference guide contains a detailed description of
        the *PedPy* 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.

    .. grid-item-card:: Developer guide
        :img-top: _static/developer_guide.svg
        :link: development
        :link-type: ref
        :link-alt: To the development guide

        Saw a typo in the documentation? Want to improve
        existing functionalities? The contributing guidelines will guide
        you through the process of improving *PedPy*.