Metadata-Version: 2.5
Name: jupedsim-network
Version: 0.2.0
Summary: Coarse network egress model for fast evacuation-time estimates, companion to JuPedSim
Project-URL: Documentation, https://pedestriandynamics.org/jupedsim-network/
Project-URL: Source, https://github.com/PedestrianDynamics/jupedsim-network
Project-URL: JuPedSim, https://www.jupedsim.org
License-Expression: LGPL-3.0-or-later
License-File: LICENSE
Requires-Python: >=3.10
Requires-Dist: numpy>=1.26
Description-Content-Type: text/markdown

# jupedsim-network

A coarse network egress model for fast estimates of evacuation times
(pre-movement plus movement). Rooms, corridors and stair flights are
nodes with an area; doors and stair entries are links with a flow
capacity. Agents move
through the graph by relations adapted from the SFPE hydraulic model. A run of a
ten-storey building takes about 0.1 s, so scenarios can be sampled many
times.

The package is a companion to [JuPedSim](https://www.jupedsim.org): use
the network model to screen scenarios and find critical cases, and the
microscopic models of JuPedSim to check geometry details. It depends only
on NumPy.

The model is a prototype. It is verified against hand calculations but
not validated against experiments, and it is not intended for
regulatory or design use; see the
[limitations](https://pedestriandynamics.org/jupedsim-network/docs/limitations/).

## Install

Python 3.10 or later:

```
pip install jupedsim-network
```

## Development

```
uv sync
uv run pytest
uv run ruff check . && uv run ruff format --check .
```

The documentation is a [Hugo](https://gohugo.io) site with the
[Hextra](https://imfing.github.io/hextra/) theme in `site/`. Hugo
(extended) and Go are needed to build it:

```
uv run --group docs python scripts/figures/make_figures.py
uv run --group docs python scripts/figures/make_gifs.py
cd site && hugo server
```

The figures and animations are not stored in git. The two scripts write
them to `site/static/images/network/` (about 2 minutes); CI runs them
before every build.

## License

LGPL-3.0-or-later, as JuPedSim.
