blob: 44e1d0ed192bb81feea06b6ff899ef456bfc2c72 [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/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<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/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 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 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="GUI Installation Guide" href="installation_guide/10_gui_installation_guide.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="main navigation">
<p class="caption"><span class="caption-text">Installation Guides</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation_guide/10_gui_installation_guide.html">GUI Installation Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation_guide/20_sim_installation_guide.html">Simulation Installation Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation_guide/21_pcm_installation_guide.html">PCM Installation Guide</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_gui_user_guide.html">GUI User Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/20_sim_user_guide.html">Simulation User Guide</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/10_documentation.html">Documentation Concept</a></li>
<li class="toctree-l1"><a class="reference internal" href="advanced_topics/20_simulator_advanced.html">Simulator</a></li>
</ul>
<p class="caption"><span class="caption-text">Other Information</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li>
<li class="toctree-l1"><a class="reference internal" href="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> &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"><span class="caption-text">Installation Guides</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation_guide/10_gui_installation_guide.html">GUI Installation Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation_guide/20_sim_installation_guide.html">Simulation Installation Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation_guide/21_pcm_installation_guide.html">PCM Installation Guide</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"><span class="caption-text">User Guides</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="user_guide/10_gui_user_guide.html">GUI User Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide/20_sim_user_guide.html">Simulation User Guide</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/10_documentation.html">Documentation Concept</a></li>
<li class="toctree-l1"><a class="reference internal" href="advanced_topics/20_simulator_advanced.html">Simulator</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="glossary.html">Glossary</a></li>
<li class="toctree-l1"><a class="reference internal" href="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>Add GUI installation guide.</p>
</div>
<p class="todo-source">(The <a class="reference internal" href="installation_guide/10_gui_installation_guide.html#id1"><em>original entry</em></a> is located in /home/cloud/simopenpass/build/doc/source/installation_guide/10_gui_installation_guide.rst, line 15.)</p>
<div class="admonition-todo admonition">
<p class="admonition-title">Todo</p>
<p>Add PCM installation guide.</p>
</div>
<p class="todo-source">(The <a class="reference internal" href="installation_guide/21_pcm_installation_guide.html#id1"><em>original entry</em></a> is located in /home/cloud/simopenpass/build/doc/source/installation_guide/21_pcm_installation_guide.rst, line 15.)</p>
<div class="admonition-todo admonition">
<p class="admonition-title">Todo</p>
<p>Create GUI user guide</p>
</div>
<p class="todo-source">(The <a class="reference internal" href="user_guide/10_gui_user_guide.html#id2"><em>original entry</em></a> is located in /home/cloud/simopenpass/build/doc/source/user_guide/10_gui_user_guide.rst, line 17.)</p>
<div class="admonition-todo admonition">
<p class="admonition-title">Todo</p>
<p>Move Inputs, Outputs, and Components to their own master section</p>
</div>
<p class="todo-source">(The <a class="reference internal" href="user_guide/20_sim_user_guide.html#id1"><em>original entry</em></a> is located in /home/cloud/simopenpass/build/doc/source/user_guide/20_sim_user_guide.rst, line 153.)</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="installation_guide/sim_installation_guide/ides/20_qt_creator.html#id1"><em>original entry</em></a> is located in /home/cloud/simopenpass/build/doc/source/installation_guide/sim_installation_guide/ides/20_qt_creator.rst, line 71.)</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="installation_guide/sim_installation_guide/ides/20_qt_creator.html#id3"><em>original entry</em></a> is located in /home/cloud/simopenpass/build/doc/source/installation_guide/sim_installation_guide/ides/20_qt_creator.rst, line 99.)</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 /home/cloud/simopenpass/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>Add basic example</p>
</div>
<p class="todo-source">(The <a class="reference internal" href="user_guide/sim_user_guide/examples/basic.html#id1"><em>original entry</em></a> is located in /home/cloud/simopenpass/build/doc/source/user_guide/sim_user_guide/examples/basic.rst, line 15.)</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/sim_user_guide/input/scenario.html#id2"><em>original entry</em></a> is located in /home/cloud/simopenpass/build/doc/source/user_guide/sim_user_guide/input/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/sim_user_guide/input/scenario.html#id3"><em>original entry</em></a> is located in /home/cloud/simopenpass/build/doc/source/user_guide/sim_user_guide/input/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/sim_user_guide/input/scenario.html#id4"><em>original entry</em></a> is located in /home/cloud/simopenpass/build/doc/source/user_guide/sim_user_guide/input/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/sim_user_guide/input/scenario.html#id5"><em>original entry</em></a> is located in /home/cloud/simopenpass/build/doc/source/user_guide/sim_user_guide/input/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/sim_user_guide/input/scenario.html#id6"><em>original entry</em></a> is located in /home/cloud/simopenpass/build/doc/source/user_guide/sim_user_guide/input/scenario.rst, line 786.)</p>
<div class="admonition-todo admonition">
<p class="admonition-title">Todo</p>
<p>The concept Cyclics and the DataStore 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/sim_user_guide/output/observation_log.html#id2"><em>original entry</em></a> is located in /home/cloud/simopenpass/build/doc/source/user_guide/sim_user_guide/output/observation_log.rst, line 58.)</p>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="installation_guide/10_gui_installation_guide.html" class="btn btn-neutral float-right" title="GUI Installation Guide" 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 type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>