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

Describe setup of OSI visualizer #63

Open
wants to merge 2 commits into
base: migration
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 29 additions & 11 deletions doc/setup/building_docker.adoc
Original file line number Diff line number Diff line change
@@ -1,11 +1,29 @@
= Building OSI visualizer Docker file

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Et malesuada fames ac turpis egestas.
Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi.
Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis.
Sed augue lacus viverra vitae congue eu.
Velit ut tortor pretium viverra suspendisse.
Amet commodo nulla facilisi nullam vehicula ipsum a.
Nibh nisl condimentum id venenatis a.
Diam vel quam elementum pulvinar etiam non quam lacus suspendisse.
= Building OSI visualizer Docker image

OSI visualizer provides a Docker file for building a Docker image.
The Docker image bundles all necessary files and dependencies for OSI visualizer.
It enables running OSI visualizer on non-Linux plattforms.

**Prerequisites**

* You have installed _Docker_ (version 19.03 or higher)
* You have installed _nvidia-docker2_

**Steps**

. Open a command line interpreter.
. Change to the OSI visualizer repository
max-rosin marked this conversation as resolved.
Show resolved Hide resolved
. Run the provided script to build the Docker image.
+
[source]
----
sh build-nvidia-docker.sh
----

**Result**

The Docker image for OSI visualizer is built.

**What to do next**

Run OSI visualizer using Docker
42 changes: 33 additions & 9 deletions doc/setup/building_visualizer.adoc
Original file line number Diff line number Diff line change
@@ -1,11 +1,35 @@
= Building OSI visualizer

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Et malesuada fames ac turpis egestas.
Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi.
Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis.
Sed augue lacus viverra vitae congue eu.
Velit ut tortor pretium viverra suspendisse.
Amet commodo nulla facilisi nullam vehicula ipsum a.
Nibh nisl condimentum id venenatis a.
Diam vel quam elementum pulvinar etiam non quam lacus suspendisse.
OSI visualizer provides a script for building OSI visualizer.

**Prerequisites**

* You have cloned the OSI visualizer repository.
* You have installed the following dependencies.
It is recommended to install the dependencies using the provided scripts.
** _cmake_ (version 3.5 or higher)
** _Qt_ (version 5.5.0 or higher)
** _ZeroMQ_ including the C++ bindings (version 4.2.1 or higher)
** _Protocol buffers_ (version 2.6.1 or higher)
** _OpenGL_
** _FMILibrary_ (version 2.0.2 or higher)
** _OSI_ (version 3.1.2 or higher)

**Steps**

. Open a command line interpreter.
. Change to the OSI visualizer repository
max-rosin marked this conversation as resolved.
Show resolved Hide resolved
. Run the provided script to build OSI visualizer.
+
[source]
----
bash build.sh
----

**Result**

OSI visualizer is built.

**What to do next**

Run OSI visualizer.
62 changes: 51 additions & 11 deletions doc/setup/installing_dependencies.adoc
Original file line number Diff line number Diff line change
@@ -1,11 +1,51 @@
= Installing dependencies

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Et malesuada fames ac turpis egestas.
Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi.
Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis.
Sed augue lacus viverra vitae congue eu.
Velit ut tortor pretium viverra suspendisse.
Amet commodo nulla facilisi nullam vehicula ipsum a.
Nibh nisl condimentum id venenatis a.
Diam vel quam elementum pulvinar etiam non quam lacus suspendisse.
= Installing dependencies of OSI visualizer

OSI visualizer provides scripts for installing all necessary dependencies.
Running the scripts will install the following dependecies:

* _Git_
* _cmake_
* _Qt
* _ZeroMQ_ including its C++ bindings
* _Protocol buffer_
* _OpenGL_
* _FMILibrary_
* _OSI_


**Prerequisites**

It is recommended to use OSI Visualizer under _Ubuntu Linux 18.04 LTS_.

**Steps**

. Open a command line interpreter.
. Change to the OSI visualizer repository
. Run the following command to update the list of available packages and upgrad your system.
max-rosin marked this conversation as resolved.
Show resolved Hide resolved
+
[source]
----
sudo apt-get update && sudo apt-get upgrade && sudo apt-get autoremove
----
+
. Run the provided script to install package dependencies.
+
[source]
----
sudo bash install-deps.sh
----
+
. Run the provided script to install OSI and FMILibrary build dependencies.
+
[source]
----
sudo bash build-install-build-deps.sh
----

**Result**

The necessary dependencies are installed.

**What to do next**

Build OSI visualizer.