| |
| |
| <!DOCTYPE html> |
| <html class="writer-html5" lang="en" > |
| <head> |
| <meta charset="utf-8" /> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| |
| <title>openPASS Documentation — openPASS Documentation</title> |
| |
| |
| |
| <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> |
| <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> |
| <link rel="stylesheet" href="_static/tabs.css" type="text/css" /> |
| <link rel="stylesheet" href="_static/css/custom.css" type="text/css" /> |
| |
| |
| |
| <link rel="shortcut icon" href="_static/openPASS.ico"/> |
| |
| |
| |
| |
| |
| |
| |
| |
| <!--[if lt IE 9]> |
| <script src="_static/js/html5shiv.min.js"></script> |
| <![endif]--> |
| |
| |
| <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> |
| <script src="_static/jquery.js"></script> |
| <script src="_static/underscore.js"></script> |
| <script src="_static/doctools.js"></script> |
| |
| <script type="text/javascript" src="_static/js/theme.js"></script> |
| |
| |
| <link rel="index" title="Index" href="genindex.html" /> |
| <link rel="search" title="Search" href="search.html" /> |
| <link rel="next" title="Getting Started" href="installation_guide/10_getting_started.html" /> |
| </head> |
| |
| <body class="wy-body-for-nav"> |
| |
| |
| <div class="wy-grid-for-nav"> |
| |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| |
| |
| <a href="#" class="icon icon-home"> openPASS |
| |
| |
| |
| |
| <img src="_static/openPASS.png" class="logo" alt="Logo"/> |
| |
| </a> |
| |
| |
| |
| |
| <div class="version"> |
| 1.0.0 |
| </div> |
| |
| |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| |
| </div> |
| |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| |
| |
| |
| |
| |
| |
| <p class="caption"><span class="caption-text">Installation Guide</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="installation_guide/10_getting_started.html">Getting Started</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="installation_guide/15_system_requirements.html">System Requirements</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="installation_guide/30_install_openpass.html">Installing openPASS</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="installation_guide/50_further_guidance.html">Further Guidance</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="installation_guide/60_conan.html">Building with Conan</a></li> |
| </ul> |
| <p class="caption"><span class="caption-text">User Guides</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/10_overview.html">Overview</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/20_tutorials.html">Tutorials</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/30_configs_in_depth.html">Configs in Depth</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/40_outputs_in_depth.html">Outputs in Depth</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/50_scenario_simulation.html">Simulator</a></li> |
| </ul> |
| <p class="caption"><span class="caption-text">Advanced topics</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="advanced_topics/20_simulator_advanced.html">Simulator</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="advanced_topics/30_testing.html">EndToEnd Test Framework</a></li> |
| </ul> |
| <p class="caption"><span class="caption-text">Developer Information</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="developer_information/10_ide_support.html">IDE Support</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="developer_information/20_documentation.html">Documentation Concept</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="developer_information/30_coding_conventions.html">Coding Guidelines</a></li> |
| </ul> |
| <p class="caption"><span class="caption-text">Other Information</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="other_information/10_external_dependencies.html">External Dependencies</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="other_information/20_glossary.html">Glossary</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="other_information/30_gui_plugins.html">GUI Plugins</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="other_information/40_license.html">License</a></li> |
| </ul> |
| |
| |
| |
| </div> |
| |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" aria-label="top navigation"> |
| |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="#">openPASS</a> |
| |
| </nav> |
| |
| |
| <div class="wy-nav-content"> |
| |
| <div class="rst-content"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div role="navigation" aria-label="breadcrumbs navigation"> |
| |
| <ul class="wy-breadcrumbs"> |
| |
| <li><a href="#" class="icon icon-home"></a> »</li> |
| |
| <li>openPASS Documentation</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="_sources/index.rst.txt" rel="nofollow"> View page source</a> |
| |
| |
| </li> |
| |
| </ul> |
| |
| |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <div class="section" id="openpass-documentation"> |
| <h1>openPASS Documentation<a class="headerlink" href="#openpass-documentation" title="Permalink to this headline">¶</a></h1> |
| <p>The openPASS (Open Platform for Assessment of Safety Systems) tool is a developed framework for the simulation of interaction between traffic participants to evaluate and parametrize active safety systems. |
| The simulation is based on a specific situation configuration and can contain several simulation runs, which differ due to random parameters.</p> |
| <p>The software suite of openPASS started as a set of stand-alone applications, which can be installed and configured individually. |
| Over time, especially the graphical user interface evolved to a single entry point, enabling the average user to use openPASS as a “monolithic” tool.</p> |
| <p>This guide contains information about installation, configuration and usage of all tools in the <strong>openPASS</strong> environment.</p> |
| <div class="toctree-wrapper compound"> |
| <p class="caption"><span class="caption-text">Installation Guide</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="installation_guide/10_getting_started.html">Getting Started</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="installation_guide/15_system_requirements.html">System Requirements</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="installation_guide/20_install_prerequisites.html">Installing Prerequisites</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="installation_guide/30_install_openpass.html">Installing openPASS</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="installation_guide/50_further_guidance.html">Further Guidance</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="installation_guide/60_conan.html">Building with Conan</a></li> |
| </ul> |
| </div> |
| <div class="admonition-todo admonition" id="id1"> |
| <p class="admonition-title">Todo</p> |
| <p>Update section for new react GUI.</p> |
| </div> |
| <p>The GUI lets the user configure the simulation and generate configuration files from all set parameters. |
| Based on these the simulation core calculates different simulation runs and compiles trace files for further processing.</p> |
| <div class="toctree-wrapper compound"> |
| <p class="caption"><span class="caption-text">User Guides</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/10_overview.html">Overview</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/20_tutorials.html">Tutorials</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/30_configs_in_depth.html">Configs in Depth</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/40_outputs_in_depth.html">Outputs in Depth</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="user_guide/50_scenario_simulation.html">Simulator</a></li> |
| </ul> |
| </div> |
| <div class="toctree-wrapper compound"> |
| <p class="caption"><span class="caption-text">Advanced topics</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="advanced_topics/20_simulator_advanced.html">Simulator</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="advanced_topics/30_testing.html">EndToEnd Test Framework</a></li> |
| </ul> |
| </div> |
| <div class="toctree-wrapper compound"> |
| <p class="caption"><span class="caption-text">Developer Information</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="developer_information/10_ide_support.html">IDE Support</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="developer_information/20_documentation.html">Documentation Concept</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="developer_information/30_coding_conventions.html">Coding Guidelines</a></li> |
| </ul> |
| </div> |
| <div class="toctree-wrapper compound"> |
| <p class="caption"><span class="caption-text">Other Information</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="other_information/10_external_dependencies.html">External Dependencies</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="other_information/20_glossary.html">Glossary</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="other_information/30_gui_plugins.html">GUI Plugins</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="other_information/40_license.html">License</a></li> |
| </ul> |
| </div> |
| </div> |
| <div class="section" id="todolist"> |
| <h1>Todolist<a class="headerlink" href="#todolist" title="Permalink to this headline">¶</a></h1> |
| <div class="admonition-todo admonition"> |
| <p class="admonition-title">Todo</p> |
| <p>The configuration is still “itchy”, as Qt creator changes the interface with every version |
| See <a class="reference external" href="https://gitlab.eclipse.org/eclipse/openpass/opSimulation/-/issues/149">https://gitlab.eclipse.org/eclipse/openpass/opSimulation/-/issues/149</a></p> |
| </div> |
| <p class="todo-source">(The <a class="reference internal" href="developer_information/ide_support/20_qt_creator.html#id1"><em>original entry</em></a> is located in W:/build/doc/source/developer_information/ide_support/20_qt_creator.rst, line 77.)</p> |
| <div class="admonition-todo admonition"> |
| <p class="admonition-title">Todo</p> |
| <p>The configuration is still “itchy”, as Qt creator changes the interface with every version |
| See <a class="reference external" href="https://gitlab.eclipse.org/eclipse/openpass/opSimulation/-/issues/149">https://gitlab.eclipse.org/eclipse/openpass/opSimulation/-/issues/149</a></p> |
| </div> |
| <p class="todo-source">(The <a class="reference internal" href="developer_information/ide_support/20_qt_creator.html#id3"><em>original entry</em></a> is located in W:/build/doc/source/developer_information/ide_support/20_qt_creator.rst, line 99.)</p> |
| <div class="admonition-todo admonition"> |
| <p class="admonition-title">Todo</p> |
| <p>Update section for new react GUI.</p> |
| </div> |
| <p class="todo-source">(The <a class="reference internal" href="#id1"><em>original entry</em></a> is located in W:/build/doc/source/index.rst, line 31.)</p> |
| <div class="admonition-todo admonition"> |
| <p class="admonition-title">Todo</p> |
| <p>We also need a way to better communicate, who is publishing what. |
| This should directly come out of the source code, to keep the documentation up to date. |
| See <a class="reference external" href="https://gitlab.eclipse.org/eclipse/openpass/opSimulation/-/issues/148">https://gitlab.eclipse.org/eclipse/openpass/opSimulation/-/issues/148</a></p> |
| </div> |
| <p class="todo-source">(The <a class="reference internal" href="user_guide/outputs/observation_log.html#id2"><em>original entry</em></a> is located in W:/build/doc/source/user_guide/outputs/observation_log.rst, line 78.)</p> |
| <div class="admonition-todo admonition"> |
| <p class="admonition-title">Todo</p> |
| <p>Update this paragraph for the new react GUI.</p> |
| </div> |
| <p class="todo-source">(The <a class="reference internal" href="user_guide/tutorials/10_scenario_simulation.html#id2"><em>original entry</em></a> is located in W:/build/doc/source/user_guide/tutorials/10_scenario_simulation.rst, line 27.)</p> |
| <div class="admonition-todo admonition"> |
| <p class="admonition-title">Todo</p> |
| <p>Write tutorial for PCM simulation</p> |
| </div> |
| <p class="todo-source">(The <a class="reference internal" href="user_guide/tutorials/20_pcm_simulation.html#id1"><em>original entry</em></a> is located in W:/build/doc/source/user_guide/tutorials/20_pcm_simulation.rst, line 17.)</p> |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| <a href="installation_guide/10_getting_started.html" class="btn btn-neutral float-right" title="Getting Started" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |
| </div> |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| © Copyright 2023 openPASS Working Group. |
| |
| </p> |
| </div> |
| |
| |
| |
| Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a |
| |
| <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> |
| |
| provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| </footer> |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| |
| |
| </body> |
| </html> |
