24.09., 9:00 - 11:00: Due to updates GitLab will be unavailable for some minutes between 09:00 and 11:00.

README.md 4.38 KB
Newer Older
1
![Vadere Logo](vadere.png "Vadere Logo")
Felix Dietrich's avatar
Felix Dietrich committed
2 3 4

---

Daniel Lehmberg's avatar
Daniel Lehmberg committed
5
# Vadere
Felix Dietrich's avatar
Felix Dietrich committed
6

7
Vadere is an open source framework for the simulation of microscopic pedestrian dynamics. Vadere provides generic model classes and visualisation and data analysis tools for two-dimensional systems. A series of pedestrian locomotion models are already implemented in the framework that are also the basis for scientific publications. Namely the optimal steps model, the gradient navigation model, and the social force model are available for simulation studies. In addition to pedestrians, other systems including cars and granular flow can be introduced into the framework.
Felix Dietrich's avatar
Felix Dietrich committed
8

9
This software runs on Windows, OS X and Linux.
Felix Dietrich's avatar
Felix Dietrich committed
10

11
Vadere has been developed by [Prof. Dr. Gerta Köster's](http://www.cs.hm.edu/die_fakultaet/ansprechpartner/professoren/koester/index.de.html)
Jakob Schöttl's avatar
Jakob Schöttl committed
12 13
research group at the [Munich University of Applied Sciences](https://www.hm.edu/) at the
[department for Computer Science and Mathematics](http://cs.hm.edu/).
Benedikt Zoennchen's avatar
Benedikt Zoennchen committed
14 15
However, we welcome contributions from external sources. 

Benedikt Zoennchen's avatar
Benedikt Zoennchen committed
16
The Vadere framework includes a mesh generator for unstructured high-quality 2D meshes called **EikMesh** which is described [here](https://gitlab.lrz.de/vadere/vadere/wikis/eikmesh/Overview). 
Felix Dietrich's avatar
Felix Dietrich committed
17

18 19
## Pipeline Status

20 21
| Branch  | Pipeline Status  | Coverage |
|:--------|:----------------:|:--------:| 
Benedikt Kleinmeier's avatar
Benedikt Kleinmeier committed
22
| master  | [![pipeline status (master)](https://gitlab.lrz.de/vadere/vadere/badges/master/pipeline.svg)](https://gitlab.lrz.de/vadere/vadere/commits/master) | [![coverage report (master)](https://gitlab.lrz.de/vadere/vadere/badges/master/coverage.svg)](https://gitlab.lrz.de/vadere/vadere/commits/master) |
23
| stable | [![pipeline status (stable)](https://gitlab.lrz.de/vadere/vadere/badges/stable/pipeline.svg)](https://gitlab.lrz.de/vadere/vadere/commits/stable) | [![coverage report (stable)](https://gitlab.lrz.de/vadere/vadere/badges/stable/coverage.svg)](https://gitlab.lrz.de/vadere/vadere/commits/stable) |
24

Felix Dietrich's avatar
Felix Dietrich committed
25 26
## Installation

27 28
### Dependencies

Benedikt Kleinmeier's avatar
Benedikt Kleinmeier committed
29
* Java 11 or above (OpenJDK recommended -> see the official [Java website](https://jdk.java.net/))
Benedikt Kleinmeier's avatar
Benedikt Kleinmeier committed
30
* OpenCL (optional but recommended -> see the [install instructions](https://gitlab.lrz.de/vadere/vadere/tree/master/Documentation/installation/OpenCL-Installation.md) for details)
31 32

### Pre-Built Releases
Daniel Lehmberg's avatar
Daniel Lehmberg committed
33

Daniel Lehmberg's avatar
Daniel Lehmberg committed
34 35 36 37
Latest build of master:
* [Windows](http://www.vadere.org/builds/master/vadere.master.windows.zip)
* [Linux](http://www.vadere.org/builds/master/vadere.master.linux.zip)

38 39
Stable releases and selected branch-builds:
* [www.vadere.org/releases/](http://www.vadere.org/releases/)
Daniel Lehmberg's avatar
Daniel Lehmberg committed
40

41 42
The ZIP file contains:
* **README.md** - this README file. 
43 44
* **vadere-gui.jar** - provides the GUI version of Vadere.
* **vadere-console.jar** - provides the command line version of Vadere and allows easy integration into other applications.
45
* **Scenarios** - contains test scenarios for pedestrian locomotion models. Note: The tests are also useful for a "getting started" (see below "Run Built-In Examples" for details).
Daniel Lehmberg's avatar
Daniel Lehmberg committed
46

47 48
### Run the Application

Benedikt Kleinmeier's avatar
Benedikt Kleinmeier committed
49
Open a terminal and enter `path/to/openjdk/java -jar vadere-gui.jar`.
50 51 52

### Run Built-In Examples

53
With the following steps, you can run a simulation with one of the built-in examples from [Scenarios](Scenarios):
54

Benedikt Kleinmeier's avatar
Benedikt Kleinmeier committed
55 56
- Start Vadere 
- Click *Project* > *Open* 
57
- Choose `vadere.project` of one of the test projects, e.g. [TestOSM](https://gitlab.lrz.de/vadere/vadere/tree/master/Scenarios/ModelTests/TestOSM) and click *open*
58
- Select the scenario on the left and press *run selected scenario*
Daniel Lehmberg's avatar
Daniel Lehmberg committed
59

60
## Build from Source
Daniel Lehmberg's avatar
Daniel Lehmberg committed
61

62
### Dependencies
Felix Dietrich's avatar
Felix Dietrich committed
63

Benedikt Kleinmeier's avatar
Benedikt Kleinmeier committed
64
* Java 11 or above (OpenJDK recommended)
Felix Dietrich's avatar
Felix Dietrich committed
65 66
* Maven 3.0
* Git
Benedikt Zoennchen's avatar
Benedikt Zoennchen committed
67
* OpenCL (optional but recommended)
Felix Dietrich's avatar
Felix Dietrich committed
68

69 70
**Note:** Please, ensure that the Git executable can be found in the `PATH` variable of your operating system.

71
### Build Instructions
72

73 74 75 76
1. git clone https://gitlab.lrz.de/vadere/vadere.git
2. cd vadere
3. mvn clean
4. mvn -Dmaven.test.skip=true package
Felix Dietrich's avatar
Felix Dietrich committed
77

78 79
## Changelog

80
See [CHANGELOG.md](https://gitlab.lrz.de/vadere/vadere/blob/master/CHANGELOG.md) for a list of changes.
Felix Dietrich's avatar
Felix Dietrich committed
81

Benedikt Zoennchen's avatar
Benedikt Zoennchen committed
82 83
## JavaDoc

Benedikt Zoennchen's avatar
Benedikt Zoennchen committed
84
- [state](http://www.vadere.org/javadoc/state/index.html)
Benedikt Zoennchen's avatar
Benedikt Zoennchen committed
85

86 87
## Contribution

88
See [CONTRIBUTING.md](https://gitlab.lrz.de/vadere/vadere/blob/master/CONTRIBUTING.md) for how to set up the development environment and the coding guidelines.
89

Felix Dietrich's avatar
Felix Dietrich committed
90 91
## License

92
This software is licensed under the GNU Lesser General Public License ([LGPL](https://gitlab.lrz.de/vadere/vadere/blob/master/LICENSE)).
Felix Dietrich's avatar
Felix Dietrich committed
93

94
For more information: http://www.gnu.org/licenses/lgpl.html