https://github.com/bonifatius94/pysocialforce

Extended Social Force Model in Python for social navigation research
https://github.com/bonifatius94/pysocialforce

social-force-model

Last synced: about 2 months ago
JSON representation

Extended Social Force Model in Python for social navigation research

• Host: GitHub
• URL: https://github.com/bonifatius94/pysocialforce
• Owner: Bonifatius94
• License: mit
• Created: 2023-08-01T15:08:56.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-02-03T22:45:44.000Z (11 months ago)
• Last Synced: 2024-02-04T19:01:45.791Z (11 months ago)
• Topics: social-force-model
• Language: Python
• Homepage:
• Size: 77.2 MB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# PySocialForce

[](https://github.com/Bonifatius94/PySocialForce/actions/workflows/ci.yml/badge.svg)

## About

This project is a Python implementation of the **Extended Social Force Model** [[2]](#2).

It extends the vanilla social force model [[1]](#1) to simulate the walking behaviour

of pedestrians with social group interactions.

The pedestrian states and other simulated entities are represented by NumPy arrays.

Performance-critical implementations of forces use Numba for significant speed-ups.

## Installation

Clone the source code.

```sh

git clone https://github.com/Bonifatius94/PySocialForce.git

```

Install the pysocialforce package and its dependencies using pip + setup.py.

```sh

pip install -e .

```

For development, run the automated tests and lint the coding style.

```sh

pylint pysocialforce

pytest tests

```

## Usage

See the usage examples in the [examples](./examples/) folder.

## License

This project is available under the MIT License.

## References

[1] Helbing, D., & Molnár, P. (1995). Social force model

for pedestrian dynamics. Physical Review E, 51(5), 4282–4286.

[2] Moussaïd, M., Perozo, N., Garnier, S., Helbing, D., & Theraulaz, G. (2010).

The walking behaviour of pedestrian social groups and its impact on crowd dynamics.

PLoS ONE, 5(4), 1–7. 

[3] Sven Kreiss's original Social Force implementation

on [GitHub](https://github.com/svenkreiss/socialforce)

[4] pedsim_ros implementation on [GitHub](https://github.com/srl-freiburg/pedsim_ros)