JuPedSim is a library to simulate pedestrian dynamics. This software is mainly developed at the Institute for Civil Safety IAS-7 of the Jülich Research Center (Forschungszentrum Jülich) in Germany.
It is easiest to install directly with pip from PyPi.org
pip install jupedsim
Please consult our documentation.
JuPedSim is licensed under GNU LGPLv3 hence we are looking forward to your contributions and would be happy to see questions, issues and pull requests.
If you have a question or a problem please open a new topic in GitHub discussions.
If you found a bug and want to give us a chance to fix it we would be very happy to hear from you. To make it easy for us to help you please include the following information when you open a new issue:
- What did JuPedSim do?
- What did you expect JuPedSim to do?
- How can we reproduce the issue?
If you encounter a bug and are would like to submit a fix feel free to open a PR, we will look into it.
Before embarking on larger work it is a good idea to discuss what you plan.
While we are very happy if you contribute we reserve us the right to decline your PR because it may not fit into our vision of JuPedSim.
Here you have two options.
You will need a C++20 capable compiler and CMake >= 3.19 installed on your
system. Then install our python dependencies via pip. Our python package
dependencies are listed in requirements.txt in the root of this repository.
Now you can call pip install .
E.g.:
cd jupedsim
pip install -r requirements.txt
pip install .You will need a C++20 capable compiler and CMake >= 3.19 installed on your
system. Then install our python dependencies via pip. Our python package
dependencies are listed in requirements.txt in the root of this repository.
Now you can generate makefiles with CMake, then compile and run the python
library.
pip install -r jupedsim/requirements.txt
mkdir jupedsim-build
cd jupedsim-build
cmake ../jupedsim
make -j
source ./environmentThe last line in the above description will populate the python path with the location of our python code and the native library.
Warning
When sourcing ./environment from the build folder you need to ensure JuPedSim
is not installed in the current python environment. Otherwise there will be
erroneous calls to the wrong python code, resulting in crashes and/or
exceptions.