pedpy
Analysis of pedestrian dynamics based on trajectory files.
Science Score: 77.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 6 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
✓Committers with academic emails
2 of 9 committers (22.2%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (18.0%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
Analysis of pedestrian dynamics based on trajectory files.
Basic Info
- Host: GitHub
- Owner: PedestrianDynamics
- License: mit
- Language: Pascal
- Default Branch: main
- Homepage: https://pedpy.readthedocs.io
- Size: 75.6 MB
Statistics
- Stars: 19
- Watchers: 3
- Forks: 12
- Open Issues: 27
- Releases: 0
Topics
Metadata Files
README.md
PedPy: Analysis of pedestrian dynamics based on trajectory files.
PedPy is a python module for pedestrian movement analysis. It implements different measurement methods for density, velocity and flow.
If you use PedPy in your work, please cite it using the following information from zenodo:
Getting started
Setup Python
For setting up your Python Environment a Python version >= 3.11 is recommended (our code is tested with 3.11, 3.12, and 3.13). 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:
bash
python3 -m pip install pedpy
You can also install the latest version of PedPy directly from the repository, by following these steps:
Uninstall an installed version of PedPy:
bash python3 -m pip uninstall pedpyInstall latest version of PedPy from repository:
python3 -m pip install git+https://github.com/PedestrianDynamics/PedPy.git
Usage
For first time users, have a look at the getting started notebook, as it shows the first steps to start an analysis with PedPy. A more detailed overview of PedPy is demonstrated in the user guide notebook. The fundamental diagram notebook shows how to use PedPy for computing the fundamental diagram of a series of experiments.
Interactive online session
If you want to try out PedPy for the first time, you can find an interactive online environments for both notebooks here:
- Getting started:
- User guide:
- Fundamental diagram:
Note: The execution might be slower compared to a local usage, as only limited resources are available. It is possible to also upload different trajectory files and run the analysis completely online, but this might not be advisable for long computations.
Local usage of the notebooks
For local usage of the notebooks, you can either download the notebooks and demo files from the GitHub repository or clone the whole repository with:
bash
git clone https://github.com/PedestrianDynamics/pedpy.git
For using either of the notebook some additional libraries need to be installed, mainly for plotting. You can install the needed libraries with:
bash
python3 -m pip install jupyter matplotlib
Afterward, you can start a jupyter server with:
bash
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.
Owner
- Name: Pedestrian Dynamics
- Login: PedestrianDynamics
- Kind: organization
- Location: Germany
- Repositories: 5
- Profile: https://github.com/PedestrianDynamics
Pedestrian Dynamics
Citation (CITATION.cff)
cff-version: 1.2.0
message: "If you use PedPy in your work, please cite it as below."
title: "PedPy - Pedestrian Trajectory Analyzer"
abstract: "Analysis of pedestrian dynamics based on trajectory files."
type: software
authors:
- family-names: "Schrödter"
given-names: "Tobias"
orcid: "https://orcid.org/0000-0002-1071-060X"
- name: "The PedPy Development Team"
repository-code: "https://github.com/PedestrianDynamics/pedpy"
keywords:
- "pedestrian dynamics"
- "pedestrian analysis"
- "research software"
license: MIT
identifiers:
- description: This is the collection of archived snapshots of all versions of PedPy
type: doi
value: "10.5281/zenodo.7194992"
- description: This is the archived snapshot of version 1.3.0 of PedPy
type: doi
value: "10.5281/zenodo.14789994"
- description: This is the archived snapshot of version 1.2.0 of PedPy
type: doi
value: "10.5281/zenodo.13850961"
- description: This is the archived snapshot of version 1.1.2 of PedPy
type: doi
value: "10.5281/zenodo.11778532"
- description: This is the archived snapshot of version 1.1.1 of PedPy
type: doi
value: "10.5281/zenodo.11622761"
- description: This is the archived snapshot of version 1.1.0 of PedPy
type: doi
value: "10.5281/zenodo.10814490"
- description: This is the archived snapshot of version 1.0.2 of PedPy
type: doi
value: "10.5281/zenodo.10016938"
- description: This is the archived snapshot of version 1.0.1 of PedPy
type: doi
value: "10.5281/zenodo.8406551"
- description: This is the archived snapshot of version 1.0.0 of PedPy
type: doi
value: "10.5281/zenodo.8405437"
version: 1.4.0-dev
GitHub Events
Total
- Create event: 24
- Release event: 3
- Issues event: 26
- Watch event: 1
- Delete event: 19
- Issue comment event: 226
- Push event: 42
- Pull request review comment event: 62
- Pull request review event: 99
- Pull request event: 87
- Fork event: 1
Last Year
- Create event: 24
- Release event: 3
- Issues event: 26
- Watch event: 1
- Delete event: 19
- Issue comment event: 226
- Push event: 42
- Pull request review comment event: 62
- Pull request review event: 99
- Pull request event: 87
- Fork event: 1
Committers
Last synced: 8 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| schroedtert | t****r@f****e | 232 |
| Mohcine Chraibi | m****i@f****e | 15 |
| dependabot[bot] | 4****] | 9 |
| ThoChat | 8****t | 3 |
| ChristianHirt | 9****t | 3 |
| Ozaq | O****q | 1 |
| Maik | 9****J | 1 |
| JuleAdrian | 5****n | 1 |
| Deniz Kilic | d****o@h****e | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 117
- Total pull requests: 328
- Average time to close issues: 3 months
- Average time to close pull requests: 16 days
- Total issue authors: 9
- Total pull request authors: 10
- Average comments per issue: 0.53
- Average comments per pull request: 0.48
- Merged pull requests: 261
- Bot issues: 0
- Bot pull requests: 41
Past Year
- Issues: 25
- Pull requests: 128
- Average time to close issues: 21 days
- Average time to close pull requests: 7 days
- Issue authors: 6
- Pull request authors: 7
- Average comments per issue: 0.44
- Average comments per pull request: 0.86
- Merged pull requests: 87
- Bot issues: 0
- Bot pull requests: 41
Top Authors
Issue Authors
- schroedtert (75)
- chraibi (14)
- ThoChat (9)
- mirakuepper (7)
- MaikFZJ (6)
- JuleAdrian (3)
- LilQuacky (1)
- gjaeger (1)
- Ozaq (1)
Pull Request Authors
- schroedtert (230)
- dependabot[bot] (41)
- chraibi (33)
- ThoChat (8)
- ChristianHirt (6)
- JuleAdrian (3)
- gitsimonr (2)
- MaikFZJ (2)
- Kilidsch (2)
- Ozaq (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 227 last-month
- Total dependent packages: 0
- Total dependent repositories: 2
- Total versions: 18
- Total maintainers: 3
pypi.org: pedpy
PedPy is a Python module for pedestrian movement analysis.
- Documentation: https://pedpy.readthedocs.io/
- License: MIT License Copyright (c) 2023 Forschungszentrum Jülich GmbH, IAS-7 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
Latest release: 1.3.2
published 10 months ago
Rankings
Maintainers (3)
Dependencies
- Shapely *
- aenum ==3.1.5
- black ==21.12b0
- build ==0.7.0
- click ==8.0.2
- numpy ==1.22.0
- pandas ==1.3.4
- pygeos *
- pygeos ==0.12.0
- pylint ==2.11.1
- pytest ==6.2.5
- pytest-mock ==3.7.0
- scipy ==1.8.0
- setuptools *
- Shapely *
- aenum *
- numpy *
- pandas *
- pygeos ==0.12.0
- scipy ==1.8.0
- actions/checkout v3 composite
- actions/download-artifact v3 composite
- actions/setup-python v4 composite
- actions/upload-artifact v3 composite
- pypa/gh-action-pypi-publish release/v1 composite
- ipykernel *
- myst-parser ==0.18.1
- pydata-sphinx-theme ==0.11.0
- readthedocs-sphinx-search ==0.1.1
- sphinx ==5.3.0
- sphinx-copybutton ==0.5.1
- sphinx_design ==0.3.0
- sphinx_rtd_theme ==1.0.0
- sphinxcontrib-apidoc ==0.3.0