.. toctree:: :maxdepth: 1 :hidden: Getting Started <notebooks/getting_started> User Guide <user_guide/index> API Reference <api/index> Developer Guide <developer_guide> Cite PedPy <citation> Changelog <changelog> Disclaimer <disclaimer>
Useful links: Python Packages | Source Repository | Issues | Discussions
PedPy is an open source, MIT-licensed Python library for pedestrian movement analysis. It provides a high-level interface for extracting fundamental measurements from trajectory data.
Basic measures as velocity, flow, and density can directly be computed and then combined to obtain fundamental diagrams. Additionally, PedPy provides functionalities to compute density and velocity profiles.
PedPy can directly be installed from PyPI via:
pip install pedpy
.. grid:: 1 2 2 2
:gutter: 4
:padding: 2 2 0 0
:class-container: sd-text-center
.. grid-item-card:: Getting Started
:img-top: _static/getting_started.svg
:class-card: intro-card
:link: notebooks/getting_started
:link-type: doc
:link-alt: To the getting started guide
New to *PedPy*? Check out the getting started guide.
It show cases a first analysis done with *PedPy*.
.. grid-item-card:: User Guide
:img-top: _static/user_guide.svg
:class-card: intro-card
:link: user_guide/index
:link-type: doc
:link-alt: To the user guide
The user guide shows more detailed applications and provides an overview of the capabilities of *PedPy*.
.. grid-item-card:: API Reference
:img-top: _static/api_reference.svg
:class-card: intro-card
:link: api/index
:link-type: doc
:link-alt: To the reference guide
A detailed description of *PedPy*'s API.
It explains the provided functions and their parameters.
.. grid-item-card:: Developer Guide
:img-top: _static/developer_guide.svg
:class-card: intro-card
:link: developer_guide
:link-type: doc
:link-alt: To the development guide
Want to help improving *PedPy*?
The developer guides explains, how you can help us to make *PedPy* better.