Add Wiki for JPSvis authored by Mohcine Chraibi's avatar Mohcine Chraibi
...@@ -2,23 +2,50 @@ ...@@ -2,23 +2,50 @@
JuPedSim comes with three loosely coupled modules: JuPedSim comes with three loosely coupled modules:
1. [JPScore](jpscore): The simulation core 1. [JPScore](home): The simulation core
2. [JPSvis](jpsvis): Geometry and trajectories visualization tool 2. [JPSvis](https://cst.version.fz-juelich.de/jupedsim/jpsvis): Geometry and trajectories visualization tool
3. [JPSreport](jpsreport): Implementation of different measurement methods to evaluate out of trajectories the density, the velocity and the flow. 3. `JPSreport`: Implementation of different measurement methods to evaluate out of trajectories the density, the velocity and the flow.
All three modules are configured by means of `xml`-files. For the time being `JuPedSim` does not come yet with a GUI to control the flow of the work. All three modules are configured by means of `xml`-files. For the time being `JuPedSim` does not come yet with a GUI to control the flow of the work.
# Requirements # Requirements
1. cmake 1. [CMake](http://www.cmake.org/)
2. g++ oder clang 2. g++ or [clang](http://clang.llvm.org/)
3. for JPSvis: [qt](http://qt-project.org/doc/qt-4.8/installation.html) and [vtk](http://www.vtk.org/VTK/resources/software.html) are needed. 3. for JPSvis additionally [Qt](http://qt-project.org/doc/qt-4.8/installation.html) and [VTK](http://www.vtk.org/VTK/resources/software.html) are needed.
# Installation # Installation
For all three modules the compilation is fairly straightforward: For all three modules the compilation is fairly straightforward:
1. mkdir build && cd build - Create a new directory and change to it
2. cmake ..
3. make -jN (`N` is the number of your CPUs) ```javascript
mkdir build && cd build
```
- Run ```CMake``` to build the project
``` javascript
cmake ..
```
(_dot dot is not a typo_)
- Compile the project
```javascript
make -jN
```
(`N` is the number of your CPUs)
- If the compilation succeeded run a simulation using one of the ini files in ```initfiles/```
For example:
```javascript
./bin/jpscore inputfiles/Bottleneck/1.1_ini-Bottleneck.xml
```
# Using an IDE
In principle ```CMake``` produces a project file for different IDE's. ```JPScore``` was tested successfully with [Eclipse](https://eclipse.org/) and [CLion](https://www.jetbrains.com/clion/). Since ```CLion``` supports ```CMake``` build system and uses it as a project model, we recommend using it with ```JPScore```.
\ No newline at end of file