From cd7d2fee3ac0d74d4295f10c147ee880ab1f42cb Mon Sep 17 00:00:00 2001 From: Maximilian Rosin Date: Wed, 31 Mar 2021 16:20:06 +0200 Subject: [PATCH] feat(docs): Create initial document structure (#56) Signed-off-by: Maximilian Rosin --- .../images => _images}/Connection.png | Bin doc/{_static/images => _images}/Demo.png | Bin .../images => _images}/FieldOfView.png | Bin doc/{_static/images => _images}/PlayBack.png | Bin .../images => _images}/SaveOSIMessage.png | Bin .../images => _images}/osi_visualizer.png | Bin doc/howtocontribute.rst | 33 ------ doc/misc/idea_visualizer.adoc | 11 ++ doc/nvidia-docker.rst | 51 --------- doc/osi-visualizer_user_guide.adoc | 53 ++++++++++ doc/panels.rst | 97 ------------------ doc/setup/building_docker.adoc | 11 ++ doc/setup/building_visualizer.adoc | 11 ++ doc/setup/installing_dependencies.adoc | 11 ++ doc/use/comparing_messages.adoc | 11 ++ doc/use/configuring_view.adoc | 11 ++ doc/use/playing_large_files.adoc | 11 ++ doc/use/playing_messages.adoc | 11 ++ doc/use/receiving_network.adoc | 11 ++ doc/use/running_visualizer.adoc | 11 ++ doc/use/running_visualizer_docker.adoc | 11 ++ doc/use/saving_messages.adoc | 11 ++ doc/use/showing_field_of_view.adoc | 11 ++ 23 files changed, 196 insertions(+), 181 deletions(-) rename doc/{_static/images => _images}/Connection.png (100%) rename doc/{_static/images => _images}/Demo.png (100%) rename doc/{_static/images => _images}/FieldOfView.png (100%) rename doc/{_static/images => _images}/PlayBack.png (100%) rename doc/{_static/images => _images}/SaveOSIMessage.png (100%) rename doc/{_static/images => _images}/osi_visualizer.png (100%) delete mode 100644 doc/howtocontribute.rst create mode 100644 doc/misc/idea_visualizer.adoc delete mode 100644 doc/nvidia-docker.rst create mode 100644 doc/osi-visualizer_user_guide.adoc delete mode 100644 doc/panels.rst create mode 100644 doc/setup/building_docker.adoc create mode 100644 doc/setup/building_visualizer.adoc create mode 100644 doc/setup/installing_dependencies.adoc create mode 100644 doc/use/comparing_messages.adoc create mode 100644 doc/use/configuring_view.adoc create mode 100644 doc/use/playing_large_files.adoc create mode 100644 doc/use/playing_messages.adoc create mode 100644 doc/use/receiving_network.adoc create mode 100644 doc/use/running_visualizer.adoc create mode 100644 doc/use/running_visualizer_docker.adoc create mode 100644 doc/use/saving_messages.adoc create mode 100644 doc/use/showing_field_of_view.adoc diff --git a/doc/_static/images/Connection.png b/doc/_images/Connection.png similarity index 100% rename from doc/_static/images/Connection.png rename to doc/_images/Connection.png diff --git a/doc/_static/images/Demo.png b/doc/_images/Demo.png similarity index 100% rename from doc/_static/images/Demo.png rename to doc/_images/Demo.png diff --git a/doc/_static/images/FieldOfView.png b/doc/_images/FieldOfView.png similarity index 100% rename from doc/_static/images/FieldOfView.png rename to doc/_images/FieldOfView.png diff --git a/doc/_static/images/PlayBack.png b/doc/_images/PlayBack.png similarity index 100% rename from doc/_static/images/PlayBack.png rename to doc/_images/PlayBack.png diff --git a/doc/_static/images/SaveOSIMessage.png b/doc/_images/SaveOSIMessage.png similarity index 100% rename from doc/_static/images/SaveOSIMessage.png rename to doc/_images/SaveOSIMessage.png diff --git a/doc/_static/images/osi_visualizer.png b/doc/_images/osi_visualizer.png similarity index 100% rename from doc/_static/images/osi_visualizer.png rename to doc/_images/osi_visualizer.png diff --git a/doc/howtocontribute.rst b/doc/howtocontribute.rst deleted file mode 100644 index f1f1a90..0000000 --- a/doc/howtocontribute.rst +++ /dev/null @@ -1,33 +0,0 @@ -Contributors' Guidelines -========================== - -Introduction ------------- - -The purpose of this document is to help contributors get started with -the OSI Visualizer codebase. - - -Reporting issues ----------------- - -The simplest way to contribute to OSI Visualizer is to report issues that you may -find with the project on `github `__. Everyone can create issues. -Always make sure to search the existing issues before reporting a new one. -Issues may be created to discuss: - -- `Feature requests or Ideas `_ -- `Bugs `_ -- `Questions `_ -- `Other `_ - -If practicable issues should be closed by a referenced pull request or commit (`here `_ you can find keywords to close issues automatically). To help developers and maintainers we provide a `pull request template `_ which will be generated each time you create a new pull request. - -See `here `_ for more on our git workflow. - -Documentation ----------------- - -- Documentation changes can be performed by anyone. -- Consider adding stuff to the `osi-documentation `_ or directly to the `doc `_ folder in the repository. -- When new changes are made directly to the `osi-documentation `_ repo the documentation will be rebuild and the new changes can be seen. When making documentation changes in the `doc `_ folder of the repository the changes will be visible when the daily chron job of osi-documentation is executed. diff --git a/doc/misc/idea_visualizer.adoc b/doc/misc/idea_visualizer.adoc new file mode 100644 index 0000000..b4656cf --- /dev/null +++ b/doc/misc/idea_visualizer.adoc @@ -0,0 +1,11 @@ += The idea of 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. \ No newline at end of file diff --git a/doc/nvidia-docker.rst b/doc/nvidia-docker.rst deleted file mode 100644 index 3dae211..0000000 --- a/doc/nvidia-docker.rst +++ /dev/null @@ -1,51 +0,0 @@ -Nvidia Docker -============== - -The aim is to be able to run the osi-visualizer in docker to -provide an automated and flexible way for downloading, installing and setting up all necessary files and dependencies for osi-visualizer. Ideally it would only take time to build the first docker image, after that starting the image, i.e. running the visualizer, will be straight forward. - -General Information -------------------- - -The following Docker version was used: Docker version 18.03.1-ce, build 9ee9f40 - -For download and installation please refer to the following link: -https://docs.docker.com/install/linux/docker-ce/ubuntu/ - -You will also need nvidia-docker2, please refer to the following link: -https://github.com/NVIDIA/nvidia-docker/wiki/Installation-(version-2.0) - -Build ------ -.. code-block:: bash - - cd osi-visualizer - sh build-nvidia-docker.sh # will build the image for you - sh run-nvidia-docker.sh # will run the visualizer for you - -OSI-Visualizer protobuf files ------------------------------ - -In order to load files into osi-visualizer, you need to place your *.pb files in "osi_pb" (mounted as a volume to the image). - -Note ------ - -Currently the osi-visualizer is set up and tested to work with the -playback option, for using other functionalities of the -osi-visualizer like socket communication then some updates should -probably be done to the docker file. - -If after running the image the following error appears: - -.. code-block:: bash - - Creating network “osi-visualizer_default” with the default driver - No protocol specified QXcbConnection: Could not connect to display:1 - -then add the following command and run the image again (no need to -build the docker image again): - -.. code-block:: bash - - sudo xhost + \ No newline at end of file diff --git a/doc/osi-visualizer_user_guide.adoc b/doc/osi-visualizer_user_guide.adoc new file mode 100644 index 0000000..769acc5 --- /dev/null +++ b/doc/osi-visualizer_user_guide.adoc @@ -0,0 +1,53 @@ += OSI Visualizer +:revnumber: v.v.v +:revdate: dd.mm.yyyy +:toc: left +:toclevels: 2 +:sectnums: + +:topicdir: topics +:reusedir: reuse + +// header & footer for html +// html themes +// +// source highlighting +:source-highlighter: rouge +:rouge-style: base16.solarized.light +// +// :nofooter: +:last-update-label!: +//embed images into html +:data-uri: +:mathematical-format: svg +:imagesoutdir: ../images/generated_images + +include::./misc/idea_visualizer.adoc[leveloffset=+1] + +== Setting up OSI Visualizer + +include::./setup/installing_dependencies.adoc[leveloffset=+2] + +include::./setup/building_visualizer.adoc[leveloffset=+2] + +include::./setup/building_docker.adoc[leveloffset=+2] + +== Using OSI Visualizer + +include::./use/running_visualizer.adoc[leveloffset=+2] + +include::./use/running_visualizer_docker.adoc[leveloffset=+2] + +include::./use/receiving_network.adoc[leveloffset=+2] + +include::./use/playing_messages.adoc[leveloffset=+2] + +include::./use/showing_field_of_view.adoc[leveloffset=+2] + +include::./use/saving_messages.adoc[leveloffset=+2] + +include::./use/comparing_messages.adoc[leveloffset=+2] + +include::./use/configuring_view.adoc[leveloffset=+2] + +include::./use/playing_large_files.adoc[leveloffset=+2] diff --git a/doc/panels.rst b/doc/panels.rst deleted file mode 100644 index 7bca1ff..0000000 --- a/doc/panels.rst +++ /dev/null @@ -1,97 +0,0 @@ -Panels -======== - -Connection: -------------- - -The channel receives osi message from the network with specific IP -address and port number, and shows up different data types. - -.. image:: _static/images/Connection.png - :align: center - -Playback: -------------- - -The channel receives osi message from the loaded file. The tool will -check a header file of the same name with a extension: .txth. If it doesn't -exist, the tool will create one automatically for the first time. A -"Delta-Delay" variable can be set to slow down the playback speed in -case of very large message files. By default this value is "0" ms. - -Example: Set it to 10 ms, each message will have 10 ms more delay for -playing. - -Besides the tool provides sending out osi message to network with specific port number. - -.. image:: _static/images/PlayBack.png - :align: center - -Show Field of View: --------------------- - -Shows the field of view for sensors, like lidar, on the grid. Users can set -minimum range, maximum range, azimuth positive angle and azimuth -negative angle. - -.. image:: _static/images/FieldOfView.png - :align: center - -Save OSI Message: ------------------- - -Log or cut out part of the osi message stream and save it to another -file. By default the threshold is 1000000 OSI messages. The User can change -this threshold in the `appconfig.cpp `_. - -.. image:: _static/images/SaveOSIMessage.png - :align: center - -Menu options ----------------- - -File Menu: -~~~~~~~~~~~~ - -``Play``: Play/Pause Channel 1 by default. - -``Python Compare``: A standalone compare tool to compare two osi -message file directly. By default, it takes the playback file from these -two channels. It supports flexible selecting random file as well. Just -put the python scripts into folder: ./Resources/Python/ before start -this tool. Then all the scripts will be shown up in the "Python Scripts" -select menu. The compare script should take the two osi files' full path -as arguments. The compare result can be exported to a text file by -clicking the "Export" button. - -``Quit``: Quit the visualizer. - -View Menu: -~~~~~~~~~~~~ - -``Combine Channels``: Config two channels' "Play/Pause" -simultaneously, or not. It can only be checked when the channels are at -the same status: both "Play" or "Pause". By default, it is unchecked. - -``Show Grid``: Show up the grid in the canvas. By default, it is -checked. - -``Show Object details``: Select object from the Objects Overview tree. -Show up the selected object's position, velocity and acceleration in -another independent dialog. By default, it is checked. - -The others are self-explaining. - -Notice ------- - -When playing large osi files, try to adapt the Delta Delay. Then the -tool renders smoothly. - -.. _OSI (Open Simulation Interface): https://github.com/OpenSimulationInterface/open-simulation-interface -.. _`https://cmake.org/`: https://cmake.org/ -.. _`http://download.qt.io/official_releases/qt/`: http://download.qt.io/official_releases/qt/ -.. _`http://zeromq.org/intro:get-the-software`: http://zeromq.org/intro:get-the-software -.. _`https://github.com/google/protobuf`: https://github.com/google/protobuf -.. _`https://svn.jmodelica.org/FMILibrary/tags`: https://svn.jmodelica.org/FMILibrary/tags -.. _Open Simulation Interface: https://github.com/OpenSimulationInterface/open-simulation-interface.git \ No newline at end of file diff --git a/doc/setup/building_docker.adoc b/doc/setup/building_docker.adoc new file mode 100644 index 0000000..b20d007 --- /dev/null +++ b/doc/setup/building_docker.adoc @@ -0,0 +1,11 @@ += 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. \ No newline at end of file diff --git a/doc/setup/building_visualizer.adoc b/doc/setup/building_visualizer.adoc new file mode 100644 index 0000000..3285439 --- /dev/null +++ b/doc/setup/building_visualizer.adoc @@ -0,0 +1,11 @@ += 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. \ No newline at end of file diff --git a/doc/setup/installing_dependencies.adoc b/doc/setup/installing_dependencies.adoc new file mode 100644 index 0000000..2283b3e --- /dev/null +++ b/doc/setup/installing_dependencies.adoc @@ -0,0 +1,11 @@ += 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. \ No newline at end of file diff --git a/doc/use/comparing_messages.adoc b/doc/use/comparing_messages.adoc new file mode 100644 index 0000000..1ac04a5 --- /dev/null +++ b/doc/use/comparing_messages.adoc @@ -0,0 +1,11 @@ += Comparing OSI message files + +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. \ No newline at end of file diff --git a/doc/use/configuring_view.adoc b/doc/use/configuring_view.adoc new file mode 100644 index 0000000..46376d4 --- /dev/null +++ b/doc/use/configuring_view.adoc @@ -0,0 +1,11 @@ += Configuring the view + +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. \ No newline at end of file diff --git a/doc/use/playing_large_files.adoc b/doc/use/playing_large_files.adoc new file mode 100644 index 0000000..770603f --- /dev/null +++ b/doc/use/playing_large_files.adoc @@ -0,0 +1,11 @@ += Playing back large OSI files + +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. \ No newline at end of file diff --git a/doc/use/playing_messages.adoc b/doc/use/playing_messages.adoc new file mode 100644 index 0000000..13463a9 --- /dev/null +++ b/doc/use/playing_messages.adoc @@ -0,0 +1,11 @@ += Playing back messages from a trace 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. \ No newline at end of file diff --git a/doc/use/receiving_network.adoc b/doc/use/receiving_network.adoc new file mode 100644 index 0000000..522ce40 --- /dev/null +++ b/doc/use/receiving_network.adoc @@ -0,0 +1,11 @@ += Receiving OSI messages from a network + +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. \ No newline at end of file diff --git a/doc/use/running_visualizer.adoc b/doc/use/running_visualizer.adoc new file mode 100644 index 0000000..6a289ee --- /dev/null +++ b/doc/use/running_visualizer.adoc @@ -0,0 +1,11 @@ += Running 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. \ No newline at end of file diff --git a/doc/use/running_visualizer_docker.adoc b/doc/use/running_visualizer_docker.adoc new file mode 100644 index 0000000..a3cffe0 --- /dev/null +++ b/doc/use/running_visualizer_docker.adoc @@ -0,0 +1,11 @@ += Running OSI visualizer using Docker + +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. \ No newline at end of file diff --git a/doc/use/saving_messages.adoc b/doc/use/saving_messages.adoc new file mode 100644 index 0000000..1d5278f --- /dev/null +++ b/doc/use/saving_messages.adoc @@ -0,0 +1,11 @@ += Saving OSI messages + +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. \ No newline at end of file diff --git a/doc/use/showing_field_of_view.adoc b/doc/use/showing_field_of_view.adoc new file mode 100644 index 0000000..44423af --- /dev/null +++ b/doc/use/showing_field_of_view.adoc @@ -0,0 +1,11 @@ += Showing the field of view of a sensor + +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. \ No newline at end of file