| |
| |
| <!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>Quick Start — 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 src="../../../_static/tabs.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="Prerequisites" href="20_prerequisites.html" /> |
| <link rel="prev" title="Sphinx" href="../meta/sphinx.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="../../../index.html" 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 class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="../../10_gui_installation_guide.html">GUI Installation Guide</a></li> |
| <li class="toctree-l1 current"><a class="reference internal" href="../../20_sim_installation_guide.html">Simulation Installation Guide</a><ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="../meta/sphinx.html">Sphinx</a></li> |
| <li class="toctree-l2 current"><a class="current reference internal" href="#">Quick Start</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="20_prerequisites.html">Prerequisites</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="30_build_prerequisites.html">Building Prerequisites</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="40_cmake.html">Cmake Build Environment</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="50_windows.html">Building under Windows</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="60_linux.html">Building under Linux</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../ides/10_vscode.html">Working with VSCode</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../ides/20_qt_creator.html">Working with Qt Creator</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../../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="../../../index.html">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="../../../index.html" class="icon icon-home"></a> »</li> |
| |
| <li><a href="../../20_sim_installation_guide.html">Simulation Installation Guide</a> »</li> |
| |
| <li>Quick Start</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="../../../_sources/installation_guide/sim_installation_guide/installation/10_quickstart.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="quick-start"> |
| <h1>Quick Start<a class="headerlink" href="#quick-start" title="Permalink to this headline">¶</a></h1> |
| <p>This section describes how compile and run <strong>openPASS</strong> as quickly as possible.</p> |
| <ol class="arabic"> |
| <li><p>Install <a class="reference internal" href="20_prerequisites.html#prerequisites"><span class="std std-ref">Prerequisites</span></a></p> |
| <p>For brevity, the following description assumes that prerequisites are located at within the repository at <code class="docutils literal notranslate"><span class="pre">deps/thirdParty</span></code>.</p> |
| </li> |
| <li><p>Get repository and submodules</p> |
| <p>For brevity, the following description assumes that the checkout path is the default <code class="docutils literal notranslate"><span class="pre">simopenpass</span></code>.</p> |
| <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git clone https://gitlab.eclipse.org/eclipse/simopenpass/simopenpass.git |
| <span class="nb">cd</span> simopenpass |
| </pre></div> |
| </div> |
| </li> |
| <li><p>Prepare build</p> |
| <p>Starting from <code class="docutils literal notranslate"><span class="pre">simopenpass</span></code></p> |
| <div class="sphinx-tabs docutils container"> |
| <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-0-0-0" aria-selected="true" class="sphinx-tabs-tab" id="tab-0-0-0" name="0-0" role="tab" tabindex="0">Windows</button><button aria-controls="panel-0-0-1" aria-selected="false" class="sphinx-tabs-tab" id="tab-0-0-1" name="0-1" role="tab" tabindex="-1">Linux</button></div><div aria-labelledby="tab-0-0-0" class="sphinx-tabs-panel" id="panel-0-0-0" name="0-0" role="tabpanel" tabindex="0"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>mkdir build |
| <span class="nb">cd</span> build |
| cmake -G <span class="s2">"MinGW Makefiles"</span><span class="se">\</span> |
| -D <span class="nv">CMAKE_PREFIX_PATH</span><span class="o">=</span><span class="s2">"/mingw64/bin;\</span> |
| <span class="s2"> ../deps/thirdParty/win64/FMILibrary;\</span> |
| <span class="s2"> ../deps/thirdParty/win64/osi;"</span><span class="se">\</span> |
| -D <span class="nv">CMAKE_INSTALL_PREFIX</span><span class="o">=</span>/C/OpenPASS/bin/core <span class="se">\</span> |
| -D <span class="nv">CMAKE_BUILD_TYPE</span><span class="o">=</span>Release <span class="se">\</span> |
| -D <span class="nv">CMAKE_WITH_DEBUG_POSTIX</span><span class="o">=</span>OFF <span class="se">\</span> |
| -D <span class="nv">OPENPASS_ADJUST_OUTPUT</span><span class="o">=</span>OFF <span class="se">\</span> |
| -D <span class="nv">USE_CCACHE</span><span class="o">=</span>ON <span class="se">\</span> |
| -D <span class="nv">CMAKE_C_COMPILER</span><span class="o">=</span>gcc <span class="se">\</span> |
| -D <span class="nv">CMAKE_CXX_COMPILER</span><span class="o">=</span>g++ <span class="se">\</span> |
| .. |
| </pre></div> |
| </div> |
| </div><div aria-labelledby="tab-0-0-1" class="sphinx-tabs-panel" hidden="true" id="panel-0-0-1" name="0-1" role="tabpanel" tabindex="0"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>mkdir build |
| <span class="nb">cd</span> build |
| cmake -D <span class="nv">CMAKE_PREFIX_PATH</span><span class="o">=</span>/opt/qt5.12.3/5.12.3/gcc_64<span class="se">\;\</span> |
| ../deps/thirdParty/linux64/FMILibrary<span class="se">\;\</span> |
| ../deps/thirdParty/linux64/boost<span class="se">\;\</span> |
| ../deps/thirdParty/linux64/osi<span class="se">\;\</span> |
| ../deps/thirdParty/linux64/protobuf<span class="se">\;\</span> |
| ../deps/thirdParty/linux64/googletest <span class="se">\</span> |
| -D <span class="nv">CMAKE_INSTALL_PREFIX</span><span class="o">=</span>/OpenPASS/bin/core <span class="se">\</span> |
| -D <span class="nv">CMAKE_BUILD_TYPE</span><span class="o">=</span>Release <span class="se">\</span> |
| -D <span class="nv">CMAKE_WITH_DEBUG_POSTIX</span><span class="o">=</span>OFF <span class="se">\</span> |
| -D <span class="nv">OPENPASS_ADJUST_OUTPUT</span><span class="o">=</span>OFF <span class="se">\</span> |
| -D <span class="nv">USE_CCACHE</span><span class="o">=</span>ON <span class="se">\</span> |
| -D <span class="nv">CMAKE_C_COMPILER</span><span class="o">=</span>gcc-10 <span class="se">\</span> |
| -D <span class="nv">CMAKE_CXX_COMPILER</span><span class="o">=</span>g++-10 <span class="se">\</span> |
| .. |
| </pre></div> |
| </div> |
| </div></div> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>Adjust paths and options based on your system and needs.</p> |
| </div> |
| </li> |
| <li><p>Optional: Build and execute unit tests</p> |
| <p>Starting from <code class="docutils literal notranslate"><span class="pre">simopenpass/build</span></code>:</p> |
| <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>make <span class="nb">test</span> <span class="nv">ARGS</span><span class="o">=</span><span class="s2">"--output-on-failure -j3"</span> |
| </pre></div> |
| </div> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>ARGS is optional, but recommended. |
| Adjust parallel build flag <code class="docutils literal notranslate"><span class="pre">-j3</span></code> based on your system.</p> |
| </div> |
| </li> |
| <li><p>Build simulation core</p> |
| <p>Starting from <code class="docutils literal notranslate"><span class="pre">simopenpass/build</span></code>:</p> |
| <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>make -j3 install |
| </pre></div> |
| </div> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>Again, adjust parallel build flag <code class="docutils literal notranslate"><span class="pre">-j3</span></code> based on your system.</p> |
| </div> |
| </li> |
| <li><p>Fix installation (we’re working on that…)</p> |
| <div class="sphinx-tabs docutils container"> |
| <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-1-1-0" aria-selected="true" class="sphinx-tabs-tab" id="tab-1-1-0" name="1-0" role="tab" tabindex="0">Windows</button><button aria-controls="panel-1-1-1" aria-selected="false" class="sphinx-tabs-tab" id="tab-1-1-1" name="1-1" role="tab" tabindex="-1">Linux</button></div><div aria-labelledby="tab-1-1-0" class="sphinx-tabs-panel" id="panel-1-1-0" name="1-0" role="tabpanel" tabindex="0"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>cp /C/OpenPASS/bin/core/bin /C/OpenPASS/bin/core |
| </pre></div> |
| </div> |
| </div><div aria-labelledby="tab-1-1-1" class="sphinx-tabs-panel" hidden="true" id="panel-1-1-1" name="1-1" role="tabpanel" tabindex="0"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>cp ./OpenPASS/bin/core/bin ./OpenPASS/bin/core |
| </pre></div> |
| </div> |
| </div></div> |
| </li> |
| <li><p>Run simulation (example)</p> |
| <p>Starting from <code class="docutils literal notranslate"><span class="pre">simopenpass/build</span></code> and using an example configuration:</p> |
| <div class="sphinx-tabs docutils container"> |
| <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-2-2-0" aria-selected="true" class="sphinx-tabs-tab" id="tab-2-2-0" name="2-0" role="tab" tabindex="0">Windows</button><button aria-controls="panel-2-2-1" aria-selected="false" class="sphinx-tabs-tab" id="tab-2-2-1" name="2-1" role="tab" tabindex="-1">Linux</button></div><div aria-labelledby="tab-2-2-0" class="sphinx-tabs-panel" id="panel-2-2-0" name="2-0" role="tabpanel" tabindex="0"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>./C/OpenPASS/bin/core/OpenPassSlave --config ../sim/contrib/examples/AEB |
| </pre></div> |
| </div> |
| </div><div aria-labelledby="tab-2-2-1" class="sphinx-tabs-panel" hidden="true" id="panel-2-2-1" name="2-1" role="tabpanel" tabindex="0"><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>./OpenPASS/bin/core/OpenPassSlave --config ../sim/contrib/examples/AEB |
| </pre></div> |
| </div> |
| </div></div> |
| </li> |
| </ol> |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| <a href="20_prerequisites.html" class="btn btn-neutral float-right" title="Prerequisites" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |
| <a href="../meta/sphinx.html" class="btn btn-neutral float-left" title="Sphinx" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| </div> |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| © 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> |