README.md 2.38 KB
Newer Older
Mohcine Chraibi's avatar
Mohcine Chraibi committed
1 2 3 4
[![Build Status](https://gitlab.version.fz-juelich.de/jupedsim/jpsvis/badges/develop/build.svg)](https://gitlab.version.fz-juelich.de/JuPedSim/jpsvis/pipelines)
[![GitHub license](https://img.shields.io/badge/license-GPL-blue.svg)](https://raw.githubusercontent.com/JuPedSim/jpsvis/master/LICENSE)


Mohcine Chraibi's avatar
Mohcine Chraibi committed
5
## Get the source code 
Ulrich Kemloh's avatar
Ulrich Kemloh committed
6

Mohcine Chraibi's avatar
Mohcine Chraibi committed
7
- The project is being developed in a [Gitlab repository](https://gitlab.version.fz-juelich.de/jupedsim/jpsvis). 
Mohcine Chraibi's avatar
Mohcine Chraibi committed
8
- Our [GitHub repository](https://github.com/JuPedSim/jpsvis) is used to host selected tags and releases.
Ulrich Kemloh's avatar
Ulrich Kemloh committed
9

Mohcine Chraibi's avatar
Mohcine Chraibi committed
10
So, get the code from Gitlab and the releases from GitHub. :-)
Ulrich Kemloh's avatar
Ulrich Kemloh committed
11

Mohcine Chraibi's avatar
Mohcine Chraibi committed
12
## Showcase and tutorials
Ulrich Kemloh's avatar
Ulrich Kemloh committed
13 14


Mohcine Chraibi's avatar
Mohcine Chraibi committed
15
To highlight some features of JuPedSim we have uploaded some videos on our [YouTube channel](https://www.youtube.com/channel/UCKS8w8CUClHEeN4K1SUSMBA).
Ulrich Kemloh's avatar
Ulrich Kemloh committed
16 17


Mohcine Chraibi's avatar
Mohcine Chraibi committed
18
## Support 
Ulrich Kemloh's avatar
Ulrich Kemloh committed
19

Mohcine Chraibi's avatar
Mohcine Chraibi committed
20
We are heavily working on this project which means that:
Ulrich Kemloh's avatar
Ulrich Kemloh committed
21

Mohcine Chraibi's avatar
Mohcine Chraibi committed
22
- It’s not done. We will be releasing new enhancements, bug fixes etc.
Mohcine Chraibi's avatar
Mohcine Chraibi committed
23
- We love your support. If you find any errors or have suggestions, please write an issue in our [issue-tracker](https://gitlab.version.fz-juelich.de/jupedsim/jpsvis/issues). We will try hard to fix it.
Mohcine Chraibi's avatar
Mohcine Chraibi committed
24
- Be patient. We are scientists and PhD/master students. Therefore, we primarily care about our research and theses. 
Ulrich Kemloh's avatar
Ulrich Kemloh committed
25

Mohcine Chraibi's avatar
Mohcine Chraibi committed
26 27
## Requirements 
For the visualization module (`jpsvis`) at least 
Ulrich Kemloh's avatar
Ulrich Kemloh committed
28

Mohcine Chraibi's avatar
Mohcine Chraibi committed
29 30 31 32
- Qt version 4.5 
- and VTK version 4.8 are required.

### Install requirements for Mac OS X (with Homebrew)
Mohcine Chraibi's avatar
Mohcine Chraibi committed
33 34

```
Mohcine Chraibi's avatar
Mohcine Chraibi committed
35
brew update
Mohcine Chraibi's avatar
Mohcine Chraibi committed
36
brew install vtk --with-qt --without-python --with-python3 --without-boost  --build-from-source
Mohcine Chraibi's avatar
Mohcine Chraibi committed
37
```
Mohcine Chraibi's avatar
Mohcine Chraibi committed
38 39

### Install packages for Debian 7.7 (Ubuntu)
Mohcine Chraibi's avatar
Mohcine Chraibi committed
40 41

```
Mohcine Chraibi's avatar
Mohcine Chraibi committed
42 43 44
sudo apt-get install libmgl-qt5
sudo apt-get install libvtk5-dev
sudo apt-get install libvtk5.8-qt4
Mohcine Chraibi's avatar
Mohcine Chraibi committed
45
```
Mohcine Chraibi's avatar
Mohcine Chraibi committed
46 47 48 49 50

Alternatively, you can download the latest version of QT [here](https://www.qt.io/download/) and the latest version of VTK [here](http://www.vtk.org/download/).


## Compiling from sources
Ulrich Kemloh's avatar
Ulrich Kemloh committed
51 52 53 54 55


You can compile the simulation core for your specific platform with the supplied cmake script.
The only requirement is a compiler supporting the new standard c++11.

Mohcine Chraibi's avatar
Mohcine Chraibi committed
56 57
### Windows (tested on Win7 with MinGW 4.8)

Ulrich Kemloh's avatar
Ulrich Kemloh committed
58

Erik Andresen's avatar
Erik Andresen committed
59 60
    cmake -G "MinGW Makefiles" CMakeLists.txt
    mingw32-make.exe
Ulrich Kemloh's avatar
Ulrich Kemloh committed
61

Mohcine Chraibi's avatar
Mohcine Chraibi committed
62 63
### Linux (tested on Ubuntu 14.04 with gcc 4.8)

Ulrich Kemloh's avatar
Ulrich Kemloh committed
64

Erik Andresen's avatar
Erik Andresen committed
65
    cmake CMakeLists.txt
Ulrich Kemloh's avatar
Ulrich Kemloh committed
66 67
    make

Mohcine Chraibi's avatar
Mohcine Chraibi committed
68 69
### OSX (tested on OSX Maverick with clang 5.1 and Yosemite with clang 6.1)

Ulrich Kemloh's avatar
Ulrich Kemloh committed
70

Erik Andresen's avatar
Erik Andresen committed
71
    cmake   CMakeLists.txt
Ulrich Kemloh's avatar
Ulrich Kemloh committed
72 73
    make

Mohcine Chraibi's avatar
Mohcine Chraibi committed
74
Note that the OpenMP acceleration might be missing under OSX