This repository was archived by the owner on Jan 21, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 25
Describe setup of OSI visualizer #63
Open
max-rosin
wants to merge
2
commits into
migration
Choose a base branch
from
61_describe_setup_of_osi_visualizer
base: migration
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | ||
| . 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 | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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.
Outdated
|
||
| . Run the provided script to build OSI visualizer. | ||
| + | ||
| [source] | ||
| ---- | ||
| bash build.sh | ||
| ---- | ||
|
|
||
| **Result** | ||
|
|
||
| OSI visualizer is built. | ||
|
|
||
| **What to do next** | ||
|
|
||
| Run OSI visualizer. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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.
Outdated
|
||
| + | ||
| [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. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.