blob: fa77655592957dd31dd06a025acfb36ee1ac59d4 [file] [log] [blame]
<!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 &mdash; OpenPASS Documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
<link rel="stylesheet" href="_static/tabs.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 data-url_root="./" id="documentation_options" 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 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">
9999.9999.9999
</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="Navigation menu">
<p class="caption" role="heading"><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/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" role="heading"><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_gui_plugins.html">GUI Plugins</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/40_configs_in_depth.html">Configs in Depth</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/50_outputs_in_depth.html">Outputs in Depth</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/60_scenario_simulation.html">Simulator</a></li>
</ul>
<p class="caption" role="heading"><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" role="heading"><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>
</ul>
<p class="caption" role="heading"><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_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="Mobile navigation menu" >
<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="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="#" class="icon icon-home"></a> &raquo;</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" role="heading"><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/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>
<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" role="heading"><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_gui_plugins.html">GUI Plugins</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/40_configs_in_depth.html">Configs in Depth</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/50_outputs_in_depth.html">Outputs in Depth</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/60_scenario_simulation.html">Simulator</a></li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><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" role="heading"><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>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><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_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</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 C:/Arbeit/050_PASS/eclipse/build/doc/source/developer_information/ide_support/20_qt_creator.rst, line 73.)</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</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 C:/Arbeit/050_PASS/eclipse/build/doc/source/developer_information/ide_support/20_qt_creator.rst, line 92.)</p>
<div class="admonition-todo admonition">
<p class="admonition-title">Todo</p>
<p>In what way do scenario agents deviate from the standard?</p>
</div>
<p class="todo-source">(The <a class="reference internal" href="user_guide/configs/scenario.html#id2"><em>original entry</em></a> is located in C:/Arbeit/050_PASS/eclipse/build/doc/source/user_guide/configs/scenario.rst, line 152.)</p>
<div class="admonition-todo admonition">
<p class="admonition-title">Todo</p>
<p>What is an EntitySelection?</p>
</div>
<p class="todo-source">(The <a class="reference internal" href="user_guide/configs/scenario.html#id3"><em>original entry</em></a> is located in C:/Arbeit/050_PASS/eclipse/build/doc/source/user_guide/configs/scenario.rst, line 158.)</p>
<div class="admonition-todo admonition">
<p class="admonition-title">Todo</p>
<p>Write a paragraph about the concept “Trajectories, OSC Actions, and so” in the developer zone.</p>
</div>
<p class="todo-source">(The <a class="reference internal" href="user_guide/configs/scenario.html#id4"><em>original entry</em></a> is located in C:/Arbeit/050_PASS/eclipse/build/doc/source/user_guide/configs/scenario.rst, line 580.)</p>
<div class="admonition-todo admonition">
<p class="admonition-title">Todo</p>
<p>Write a paragraph in the developer zone about the concept “wrapping FMUs” and the “OSMP FMU”</p>
</div>
<p class="todo-source">(The <a class="reference internal" href="user_guide/configs/scenario.html#id5"><em>original entry</em></a> is located in C:/Arbeit/050_PASS/eclipse/build/doc/source/user_guide/configs/scenario.rst, line 755.)</p>
<div class="admonition-todo admonition">
<p class="admonition-title">Todo</p>
<p>Write a paragraph in the developer zone about the concept “Component State Change”</p>
</div>
<p class="todo-source">(The <a class="reference internal" href="user_guide/configs/scenario.html#id6"><em>original entry</em></a> is located in C:/Arbeit/050_PASS/eclipse/build/doc/source/user_guide/configs/scenario.rst, line 786.)</p>
<div class="admonition-todo admonition">
<p class="admonition-title">Todo</p>
<p>The concept Cyclics and the DataBuffer needs further explanation.
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.</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 C:/Arbeit/050_PASS/eclipse/build/doc/source/user_guide/outputs/observation_log.rst, line 58.)</p>
<div class="admonition-todo admonition">
<p class="admonition-title">Todo</p>
<p>Check description of Delta</p>
</div>
<p class="todo-source">(The <a class="reference internal" href="user_guide/sim_user_guide/components/driver.html#id1"><em>original entry</em></a> is located in C:/Arbeit/050_PASS/eclipse/build/doc/source/user_guide/sim_user_guide/components/driver.rst, line 46.)</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 C:/Arbeit/050_PASS/eclipse/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">
<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>&#169; Copyright 2021 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>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>