Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve online documentation #1277

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/source/concepts/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,18 @@
Concepts
========

The underlying concepts of the different parts of *JuPedSim* are explained here.
If you want to know in more detail how the simulation works, have a look:

.. list-table::
:widths: 20 80
:widths: 10 90

* - :doc:`Geometry <geometry>`
- How the simulation environment is handled *JuPedSim*

* - :doc:`Routing <routing>`
- How the routing is handled in *JuPedSim*



.. toctree::
:maxdepth: 1
:hidden:
Expand Down
36 changes: 18 additions & 18 deletions docs/source/history.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ Balancing performance and Complexity with C++
Central to the new JuPedSim is its architecture. Revising the architectural
choices, we've transitioned from a singular focus on performance to a more
balanced perspective. Instead of multithreading, JuPedSim now operates
single-threaded, relegating only performanc-critical segments to C++. This
single-threaded, relegating only performance-critical segments to C++. This
decision stems from recognizing that excessive complexity can deter users.
While we acklowdege there's room for further enhancements, especially regarding
While we acknowledge there's room for further enhancements, especially regarding
the integration of new models, the primary aim of this release was not solely
performance but to strike a harmony between speed and user-friendliness.

Expand All @@ -48,7 +48,7 @@ to easily craft simulation scenarios, prototype complex behaviors, and harness
the power of the core "primitive" components. The enhanced version of JuPedSim
adopts a novel approach by operating as a library based on Python. This new
architecture greatly enhances the versatility in configuring simulations. For
instance, one can easily define dynamically chanching behaviors such as
instance, one can easily define dynamically changing behaviors such as
arranging pedestrians in spiral formations and having individuals depart from
the formation every 3 seconds. This Python API provides users with a familiar
and intuitive programming language, enabling them to efficiently manipulate and
Expand Down Expand Up @@ -88,14 +88,14 @@ comprehending pedestrian dynamics in complex environments.

Source: Pinar Usten

To give an example, in this [study](https://doi.org/10.1098/rsos.211822),
motivation among agents is represented by the parameter $T$. Higher motivation,
like in jostling situations, correlates with a smaller $T$ value, causing
To give an example, in this `study <https://doi.org/10.1098/rsos.211822>`_,
motivation among agents is represented by the parameter :math:`T`. Higher motivation,
like in jostling situations, correlates with a smaller :math:`T` value, causing
pedestrians to quickly close gaps. For example, highly motivated agents might
have $T=0.1s$, while less motivated ones might sit at $T=1.3s$. But what if the
have :math:`T=0.1s`, while less motivated ones might sit at :math:`T=1.3s`. But what if the
motivation of people varies with time and space? Consider an exit scenario:
those closer to an exit in a crowd are more motivated than those far behind,
indicating a need for $T$ to be dynamic.
indicating a need for :math:`T` to be dynamic.

This is where the new JuPedSim shines — it can adjust this "motivation
behavior" in real-time during a simulation, providing a nuanced, adaptive, and
Expand All @@ -110,33 +110,33 @@ department, police, transport companies, security services, event organizers
and venue operators.

We started with the project
[Hermes](https://www.sifo.de/sifo/de/projekte/schutz-und-rettung-von-menschen/schutz-und-rettung-von-menschen/hermes/hermes-erforschung-eines-evaku-nfall-bei-grossveranstaltungen.html)
`Hermes <https://www.sifo.de/sifo/de/projekte/schutz-und-rettung-von-menschen/schutz-und-rettung-von-menschen/hermes/hermes-erforschung-eines-evaku-nfall-bei-grossveranstaltungen.html>`_
and designed JuPedSim in a way that it could be utilized to simulate the
evacuation of a stadium in Düsseldorf. Within the project
[ORPHEUS](https://www.orpheus-projekt.de) we investigated a **large-scale
`ORPHEUS <https://www.orpheus-projekt.de>`_ we investigated a **large-scale
evacuation** scenario of an underground station in Berlin. As a part of the
project [KapaKrit](https://www.kapakrit.de) different crowd management measures
project `KapaKrit <https://www.kapakrit.de>`_ different crowd management measures
were investigated with JuPedSim to determine the capacity of a train station
for a large-scale evacuation of the city Dortmund.


In recent years the investigation of arrival and departure processes at **major
events** has increasingly come into focus. Empirical findings from the projects
[BaSiGo](https://www.sifo.de/sifo/de/projekte/schutz-und-rettung-von-menschen/schutz-und-rettung-von-menschen/basigo/basigo-bausteine-fuer-die-sich-rheit-von-grossveranstaltungen.html)
and [CroMa](https://www.croma-projekt.de/de) regarding **crowd management
`BaSiGo <https://www.sifo.de/sifo/de/projekte/schutz-und-rettung-von-menschen/schutz-und-rettung-von-menschen/basigo/basigo-bausteine-fuer-die-sich-rheit-von-grossveranstaltungen.html>`_
and `CroMa <https://www.croma-projekt.de/de>`_) regarding **crowd management
measures and waiting behavior** have created an improved data basis for
enhancing our software and the models accordingly. In doing so, we continuously
take into account practical challenges and issues. Since 2019, we have been
working closely with people responsible for event safety (such as event
planners and authorities) as part of the [SISAME/SISAME
2.0](https://www.sisame.de/) project. In interdisciplinary workshops, we have
planners and authorities) as part of the `SISAME/SISAME
2.0 <https://www.sisame.de/>`_ project. In interdisciplinary workshops, we have
worked out how simulations can help in planning events and have accordingly
advanced the development of JuPedSim. Another goal of SISAME is the coupling
with [SUMO](https://sumo.dlr.de), a simulation software for modelling urban
with `SUMO <https://sumo.dlr.de>`_, a simulation software for modelling urban
traffic (private and public transport). One of our main goals is to enable,
together with SUMO, a holistic simulation that combines a wide variety of
transport modes and pedestrian streams. In the current project
[CroMa-PRO](https://www.sifo.de/sifo/shareddocs/Downloads/P-Umrisse/projektumriss_croma-pro.pdf?__blob=publicationFile&v=2),
`CroMa-PRO <https://www.sifo.de/sifo/shareddocs/Downloads/P-Umrisse/projektumriss_croma-pro.pdf?__blob=publicationFile&v=2>`_,
JuPedSim is being improved for the use in event planning. In this context, the
modeling of waiting behavior will be improved and the routing should be made
more flexible in order to be able to reflect crowd management measures.
Expand All @@ -145,7 +145,7 @@ for the 2024 UEFA European Football Championship in Düsseldorf.

With the new release of JuPedSim we have bundled our experiences from the last
decades and provide a powerful simulation tool, that can be used for
investigating different aspects of crowd dynamics ranginge from large-scale
investigating different aspects of crowd dynamics ranging from large-scale
evacuation scenarios to crowd-management measures such as waiting in queues.
See for yourself:

Expand Down
4 changes: 2 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ JuPedSim
:hidden:

Getting started <notebooks/getting_started>
API reference <api/jupedsim/index>
Concepts <concepts/index>
Notebooks <notebooks/index>
History <history>
Disclaimer <disclaimer>
API reference <api/jupedsim/index>


**Useful links**:
Expand All @@ -33,7 +33,7 @@ looking at how this application was used and abused we decided to rewrite
refer to the old CLI application.

If you are interested to learn about the history of this project, see
:ref:`_history`
:ref:`here <history>`.

Where to get it
===============
Expand Down