PedPy 1.0.0rc1

PedPy is a python module for pedestrian movement analysis.

PedPy

PedPy is a python module for pedestrian movement analysis. It implements different measurement methods for density, velocity and flow.

This repo is a port from the original JPSreport to a Python implementation, and will provide the same functionalities.

Getting started

Setup Python

For setting up your Python Environment a Python version >= 3.8 is recommended (our code is tested with 3.8 and 3.10). To avoid conflicts with other libraries/applications the usage of virtual environments is recommended, see Python Documentation for more detail.

Installing PedPy

To install the latest stable version of PedPy and its dependencies from PyPI:

python3 -m pip install pedpy

If you want to install the current version in the repository which might be unstable, you can do so via:

python3 -m pip install --pre --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ pedpy

Usage

The general usage of PedPy is demonstrated in the usage notebook. The JPSreport notebook shows how to use PedPy to compute the same results as in the different JPSreport methods.

You can either download the notebooks and demo files from the GitHub repository or clone the whole repository with:

git clone https://github.com/PedestrianDynamics/pedestrian-trajectory-analyzer.git

For using the either of the notebook some additional libraries need to be installed, mainly for plotting. You can install the needed libraries with:

python3 -m pip install jupyter matplotlib

Afterwards you can start a jupyter server with:

jupyter notebook

After navigating to one of the notebooks, you can see how the library can be used for different kinds of analysis.

Some examples how the computed values can be visualized are also shown in the notebooks, e.g., density/velocity profiles, fundamental diagrams, N-T-diagrams, etc.