Git Product home page Git Product logo

jupedsim's Introduction

DOI GitHub license PyPI - Python Version PyPI - Version

Jülich Pedestrian Simulator - JuPedSim

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.

Installation

It is easiest to install directly with pip from PyPi.org

pip install jupedsim

Usage

Please consult our documentation.

Contributing

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.

Questions

If you have a question or a problem please open a new topic in GitHub discussions.

Issues

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?

Pull Requests

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.

License

GNU LGPLv3

Building from source

Here you have two options.

With setuptools

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 .

Compile yourself

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 ./environment

The 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.

jupedsim's People

Contributors

chraibi avatar piccolodream avatar ozaq avatar arnegraf avatar schroedtert avatar erik-andresen avatar zeroset avatar gjaeger avatar f-mack avatar oschmi avatar jetteschumann avatar xuqiancheng avatar abrkic0 avatar kk1612 avatar katharina1219 avatar christianhirt avatar sainho93 avatar ces42 avatar arnogb avatar caoshuchao avatar anna-braun avatar behrisch avatar planospeedo avatar grgrlmml avatar bsteinb avatar shikhalevd avatar guidobasten avatar angelobanse avatar shuchao-git avatar valvku avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.