Skip to content
This repository was archived by the owner on Jan 21, 2022. It is now read-only.

Commit 3461a72

Browse files
max-rosinmax-rosin
committed
Describe setup of OSI visualizer (#61)
Signed-off-by: Maximilian Rosin <[email protected]>
1 parent 2a8806b commit 3461a72

File tree

3 files changed

+113
-31
lines changed

3 files changed

+113
-31
lines changed

‎doc/setup/building_docker.adoc

+29-11
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,29 @@
1-
= Building OSI visualizer Docker file
2-
3-
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
4-
Et malesuada fames ac turpis egestas.
5-
Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi.
6-
Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis.
7-
Sed augue lacus viverra vitae congue eu.
8-
Velit ut tortor pretium viverra suspendisse.
9-
Amet commodo nulla facilisi nullam vehicula ipsum a.
10-
Nibh nisl condimentum id venenatis a.
11-
Diam vel quam elementum pulvinar etiam non quam lacus suspendisse.
1+
= Building OSI visualizer Docker image
2+
3+
OSI visualizer provides a Docker file for building a Docker image.
4+
The Docker image bundles all necessary files and dependencies for OSI visualizer.
5+
It enables running OSI visualizer on non-Linux plattforms.
6+
7+
**Prerequisites**
8+
9+
* You have installed _Docker_ (version 19.03 or higher)
10+
* You have installed _nvidia-docker2_
11+
12+
**Steps**
13+
14+
. Open a command line interpreter.
15+
. Change to the OSI visualizer repository
16+
. Run the provided script to build the Docker image.
17+
+
18+
[source]
19+
----
20+
sh build-nvidia-docker.sh
21+
----
22+
23+
**Result**
24+
25+
The Docker image for OSI visualizer is built.
26+
27+
**What to do next**
28+
29+
Run OSI visualizer using Docker

‎doc/setup/building_visualizer.adoc

+33-9
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,35 @@
11
= Building OSI visualizer
22

3-
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
4-
Et malesuada fames ac turpis egestas.
5-
Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi.
6-
Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis.
7-
Sed augue lacus viverra vitae congue eu.
8-
Velit ut tortor pretium viverra suspendisse.
9-
Amet commodo nulla facilisi nullam vehicula ipsum a.
10-
Nibh nisl condimentum id venenatis a.
11-
Diam vel quam elementum pulvinar etiam non quam lacus suspendisse.
3+
OSI visualizer provides a script for building OSI visualizer.
4+
5+
**Prerequisites**
6+
7+
* You have cloned the OSI visualizer repository.
8+
* You have installed the following dependencies.
9+
It is recommended to install the dependencies using the provided scripts.
10+
** _cmake_ (version 3.5 or higher)
11+
** _Qt_ (version 5.5.0 or higher)
12+
** _ZeroMQ_ including the C++ bindings (version 4.2.1 or higher)
13+
** _Protocol buffers_ (version 2.6.1 or higher)
14+
** _OpenGL_
15+
** _FMILibrary_ (version 2.0.2 or higher)
16+
** _OSI_ (version 3.1.2 or higher)
17+
18+
**Steps**
19+
20+
. Open a command line interpreter.
21+
. Change to the OSI visualizer repository
22+
. Run the provided script to build OSI visualizer.
23+
+
24+
[source]
25+
----
26+
bash build.sh
27+
----
28+
29+
**Result**
30+
31+
OSI visualizer is built.
32+
33+
**What to do next**
34+
35+
Run OSI visualizer.

‎doc/setup/installing_dependencies.adoc

+51-11
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,51 @@
1-
= Installing dependencies
2-
3-
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
4-
Et malesuada fames ac turpis egestas.
5-
Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi.
6-
Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis.
7-
Sed augue lacus viverra vitae congue eu.
8-
Velit ut tortor pretium viverra suspendisse.
9-
Amet commodo nulla facilisi nullam vehicula ipsum a.
10-
Nibh nisl condimentum id venenatis a.
11-
Diam vel quam elementum pulvinar etiam non quam lacus suspendisse.
1+
= Installing dependencies of OSI visualizer
2+
3+
OSI visualizer provides scripts for installing all necessary dependencies.
4+
Running the scripts will install the following dependecies:
5+
6+
* _Git_
7+
* _cmake_
8+
* _Qt
9+
* _ZeroMQ_ including its C++ bindings
10+
* _Protocol buffer_
11+
* _OpenGL_
12+
* _FMILibrary_
13+
* _OSI_
14+
15+
16+
**Prerequisites**
17+
18+
It is recommended to use OSI Visualizer under _Ubuntu Linux 18.04 LTS_.
19+
20+
**Steps**
21+
22+
. Open a command line interpreter.
23+
. Change to the OSI visualizer repository
24+
. Run the following command to update the list of available packages and upgrad your system.
25+
+
26+
[source]
27+
----
28+
sudo apt-get update && sudo apt-get upgrade && sudo apt-get autoremove
29+
----
30+
+
31+
. Run the provided script to install package dependencies.
32+
+
33+
[source]
34+
----
35+
sudo bash install-deps.sh
36+
----
37+
+
38+
. Run the provided script to install OSI and FMILibrary build dependencies.
39+
+
40+
[source]
41+
----
42+
sudo bash build-install-build-deps.sh
43+
----
44+
45+
**Result**
46+
47+
The necessary dependencies are installed.
48+
49+
**What to do next**
50+
51+
Build OSI visualizer.

0 commit comments

Comments
 (0)