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

---

5
# VADERE
Felix Dietrich's avatar
Felix Dietrich committed
6

7
VADERE is an open source framework for the simulation of microscopic pedestrian dynamics. In addition to this core domain, other systems including cars and granular flow can be introduced into the framework. VADERE provides generic model classes and visualisation and data analysis tools for two-dimensional systems. A series of simulation 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.
Felix Dietrich's avatar
Felix Dietrich committed
8

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

Jakob Schöttl's avatar
Jakob Schöttl committed
11
12
13
14
VADERE has been developed by [Prof. Dr. Gerta Köster's](http://www.cs.hm.edu/die_fakultaet/ansprechpartner/professoren/koester/index.de.html)
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/).
However, we welcome contributions from external sources.
Felix Dietrich's avatar
Felix Dietrich committed
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

## Installation

### Dependencies

* Java 8
* Maven 3.0
* Git
* OpenCL

### Install OpenCL

For this project, GPGPU with OpenCL is used to speed up some computations. Therefore, the following requirements have to be met:

* the latest drivers for your OpenCL device(s)
* an OpenCL SDK

#### Operating Systems

* Windows: For further information using OpenCL on Windows [click here](https://streamcomputing.eu/blog/2015-03-16/how-to-install-opencl-on-windows/).
* OS X: OpenCL is pre-installed for OS X.
* Linux: Please refer to the installation manual of your Linux distribution.

### Build the Application

Run `git clone https://gitlab.lrz.de/vadere/vadere`. Go to the project directory and run `mvn clean package` (or `mvn clean package -DskipTests` if you want to skip the unit tests).

### Run Application

44
After building the application, you can start VADERE by running `java -jar VadereGui/target/gui-0.1-SNAPSHOT-jar-with-dependencies.jar`.
Felix Dietrich's avatar
Felix Dietrich committed
45

46
## Usage Example
Felix Dietrich's avatar
Felix Dietrich committed
47
48
49

With the following steps, you can start a scenario of the [ExampleProject](Documentation/Examples/ExampleProject):

50
51
- start VADERE
- *Project* > *Open*
Felix Dietrich's avatar
Felix Dietrich committed
52
53
54
55
56
57
58
59
60
61
62
63
- choose `vadere.project` and click *open*
- select the scenario on the left and press *run selected scenario*


## Development Setup

Follow the installation instructions above. Go to the project directory and run `mvn clean install`. The project can now be imported *As Maven Project* in your IDE.

### Eclipse

- *File* > *Import* > *Maven* > *Existing Maven Projects*
- choose `pom.xml` as *Root Directory* and click *Finish*
64
- open *Vaderegui (gui)* > *src* > *org.vadere.gui.projectview* > `Vadereapplication`
Felix Dietrich's avatar
Felix Dietrich committed
65
66
67

### IntelliJ IDEA

68
- on the welcome-screen select *Import Project*
Felix Dietrich's avatar
Felix Dietrich committed
69
- select `pom.xml` > *Next* > *Next* > *Next* > *Finish*
70
- open *VadereGui (gui)* > *src* > *org.vadere.gui.projectview* > `VadereApplication`
Felix Dietrich's avatar
Felix Dietrich committed
71
72
73
74
75
76
- click the *run*-icon next to the `main` method

Alternatively, run `mvn eclipse:eclipse` using the [Maven Eclipse Plugin](http://maven.apache.org/plugins/maven-eclipse-plugin/usage.html) or `mvn idea:idea` using the [Maven IntelliJ Plugin](http://maven.apache.org/plugins/maven-idea-plugin/).

## Contribution

Jakob Schöttl's avatar
Jakob Schöttl committed
77
Please see [Contribution guidelines](CONTRIBUTING.md). The document defines guidelines for coding style and commit messages.
Felix Dietrich's avatar
Felix Dietrich committed
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

## Release History

0.1	initial release of the software as open source


## Contributors

People who have contributed code to the project at the Munich University of Applied Sciences (in alphabetical order):

Florian Albrecht, Benjamin Degenhart, Felix Dietrich, Benedikt Kleinmeier, Jakob Schöttl, Michael Seitz, Swen Stemmer, Isabella von Sivers, Mario Teixeira Parente, Benedikt Zönnchen


## License

This software is licensed under the GNU Lesser General Public License ([LGPL](LICENSE)).
Jakob Schöttl's avatar
Jakob Schöttl committed
94
More information: http://www.gnu.org/licenses/lgpl.html
Felix Dietrich's avatar
Felix Dietrich committed
95
96
97