| <!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>Installing OpenPASS — 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 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="Further Guidance" href="50_further_guidance.html" /> | |
| <link rel="prev" title="Installing Prerequisites" href="20_install_prerequisites.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"> | |
| 0.8.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 class="current"> | |
| <li class="toctree-l1"><a class="reference internal" href="10_getting_started.html">Getting Started</a></li> | |
| <li class="toctree-l1"><a class="reference internal" href="20_install_prerequisites.html">Installing Prerequisites</a></li> | |
| <li class="toctree-l1 current"><a class="current reference internal" href="#">Installing OpenPASS</a></li> | |
| <li class="toctree-l1"><a class="reference internal" href="50_further_guidance.html">Further Guidance</a></li> | |
| <li class="toctree-l1"><a class="reference internal" href="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_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"><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> | |
| </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_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>Installing OpenPASS</li> | |
| <li class="wy-breadcrumbs-aside"> | |
| <a href="../_sources/installation_guide/30_install_openpass.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="installing-openpass"> | |
| <span id="download-and-install-openpass"></span><h1>Installing OpenPASS<a class="headerlink" href="#installing-openpass" title="Permalink to this headline">¶</a></h1> | |
| <p>This section describes how compile and run <strong>openPASS</strong>. Please make sure that all prerequisites have been properly installed according to section <a class="reference internal" href="20_install_prerequisites.html#prerequisites"><span class="std std-ref">Installing Prerequisites</span></a>. | |
| If you have strictly followed the instructions, the installed source packages should be located on your machine under | |
| <code class="docutils literal notranslate"><span class="pre">C:\OpenPASS\thirdParty</span></code> for <strong>Windows</strong> and <code class="docutils literal notranslate"><span class="pre">~/OpenPASS/thirdParty</span></code> for <strong>Linux</strong>. If there is a path deviation, | |
| the following commands must be adjusted.</p> | |
| <p>To keep the installation process of <strong>openPASS</strong> as simple as possible, we again recommend a specific folder structure. | |
| If you have strictly followed and will follow the recommended paths of this guide, no command modifications are necessary.</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">Notes for 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">Notes for 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"><ul class="simple"> | |
| <li><p>Recommended checkout path of <strong>openPASS</strong> repository: <code class="docutils literal notranslate"><span class="pre">C:\simopenpass</span></code></p></li> | |
| <li><p>Recommended dependendy directory within the <strong>openPASS</strong> repository: <code class="docutils literal notranslate"><span class="pre">C:\simopenpass\deps\thirdParty</span></code></p></li> | |
| <li><p>Recommended installation directory of <strong>openPASS</strong>: <code class="docutils literal notranslate"><span class="pre">C:\OpenPASS\bin\core</span></code></p></li> | |
| </ul> | |
| </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"><ul class="simple"> | |
| <li><p>Recommended checkout path of <strong>openPASS</strong> repository: <code class="docutils literal notranslate"><span class="pre">~/simopenpass</span></code></p></li> | |
| <li><p>Recommended dependendy directory within the <strong>openPASS</strong> repository: <code class="docutils literal notranslate"><span class="pre">~/simopenpass/deps/thirdParty</span></code></p></li> | |
| <li><p>Recommended installation directory of <strong>openPASS</strong>: <code class="docutils literal notranslate"><span class="pre">/usr/local/OpenPASS/bin/core</span></code></p></li> | |
| </ul> | |
| </div></div> | |
| <p>The above directory structure will be created by following the instructions of this guide.</p> | |
| <ol class="arabic"> | |
| <li><p>Clone <strong>OpenPASS</strong> repository</p> | |
| <p>As described above, the checkout path of the repository is assumed to be the default <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-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"><p>Start <code class="docutils literal notranslate"><span class="pre">MinGW</span> <span class="pre">64-bit</span></code> shell</p> | |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">/</span><span class="n">C</span><span class="o">/</span> | |
| <span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">gitlab</span><span class="o">.</span><span class="n">eclipse</span><span class="o">.</span><span class="n">org</span><span class="o">/</span><span class="n">eclipse</span><span class="o">/</span><span class="n">simopenpass</span><span class="o">/</span><span class="n">simopenpass</span><span class="o">.</span><span class="n">git</span> | |
| </pre></div> | |
| </div> | |
| <div class="admonition note"> | |
| <p class="admonition-title">Note</p> | |
| <p>As stated in <a class="reference internal" href="20_install_prerequisites.html#building-under-windows"><span class="std std-ref">Installing the Build Environment</span></a>, the windows programming tools suffer from a <cite>path length restriction</cite>. | |
| This error manifests as strange <strong>file not found</strong> compile errors. | |
| It is therefore recommended to use a short path for source code checkout, e.g. a drive letter. | |
| This can also be done by the windows command <a class="reference external" href="https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/subst">subst</a>.</p> | |
| </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"><p>Start <code class="docutils literal notranslate"><span class="pre">Bash</span></code> shell</p> | |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">~</span> | |
| <span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">gitlab</span><span class="o">.</span><span class="n">eclipse</span><span class="o">.</span><span class="n">org</span><span class="o">/</span><span class="n">eclipse</span><span class="o">/</span><span class="n">simopenpass</span><span class="o">/</span><span class="n">simopenpass</span><span class="o">.</span><span class="n">git</span> | |
| </pre></div> | |
| </div> | |
| </div></div> | |
| </li> | |
| <li><p>Navigate into repository and checkout main branch</p> | |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">simopenpass</span> | |
| <span class="n">git</span> <span class="n">checkout</span> <span class="n">main</span> | |
| </pre></div> | |
| </div> | |
| </li> | |
| <li><p>Create directory structure</p> | |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">mkdir</span> <span class="o">-</span><span class="n">p</span> <span class="n">deps</span><span class="o">/</span><span class="n">thirdParty</span> | |
| </pre></div> | |
| </div> | |
| </li> | |
| <li><p>Navigate into directory where installed prerequisites are located</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-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">/</span><span class="n">C</span><span class="o">/</span><span class="n">OpenPASS</span><span class="o">/</span><span class="n">thirdParty</span> | |
| </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-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">~/</span><span class="n">OpenPASS</span><span class="o">/</span><span class="n">thirdParty</span> | |
| </pre></div> | |
| </div> | |
| </div></div> | |
| </li> | |
| <li><p>Copy prerequisites into repository (c.f. <a class="reference internal" href="20_install_prerequisites.html#prerequisites"><span class="std std-ref">Installing Prerequisites</span></a>)</p> | |
| <div class="sphinx-tabs docutils container"> | |
| <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-3-3-0" aria-selected="true" class="sphinx-tabs-tab" id="tab-3-3-0" name="3-0" role="tab" tabindex="0">Windows</button><button aria-controls="panel-3-3-1" aria-selected="false" class="sphinx-tabs-tab" id="tab-3-3-1" name="3-1" role="tab" tabindex="-1">Linux</button></div><div aria-labelledby="tab-3-3-0" class="sphinx-tabs-panel" id="panel-3-3-0" name="3-0" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cp</span> <span class="o">-</span><span class="n">r</span> <span class="n">osi</span> <span class="o">/</span><span class="n">C</span><span class="o">/</span><span class="n">simopenpass</span><span class="o">/</span><span class="n">deps</span><span class="o">/</span><span class="n">thirdParty</span> | |
| <span class="n">cp</span> <span class="o">-</span><span class="n">r</span> <span class="n">FMILibrary</span> <span class="o">/</span><span class="n">C</span><span class="o">/</span><span class="n">simopenpass</span><span class="o">/</span><span class="n">deps</span><span class="o">/</span><span class="n">thirdParty</span> | |
| </pre></div> | |
| </div> | |
| </div><div aria-labelledby="tab-3-3-1" class="sphinx-tabs-panel" hidden="true" id="panel-3-3-1" name="3-1" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cp</span> <span class="o">-</span><span class="n">r</span> <span class="n">osi</span> <span class="o">~/</span><span class="n">simopenpass</span><span class="o">/</span><span class="n">deps</span><span class="o">/</span><span class="n">thirdParty</span> | |
| <span class="n">cp</span> <span class="o">-</span><span class="n">r</span> <span class="n">FMILibrary</span> <span class="o">~/</span><span class="n">simopenpass</span><span class="o">/</span><span class="n">deps</span><span class="o">/</span><span class="n">thirdParty</span> | |
| </pre></div> | |
| </div> | |
| </div></div> | |
| <p id="ref-prerequisites">Once prerequisites are in place, all third party dependencies within <code class="docutils literal notranslate"><span class="pre">simopenpass</span></code> can be resolved by <code class="docutils literal notranslate"><span class="pre">CMake</span></code>. | |
| For <code class="docutils literal notranslate"><span class="pre">CMake</span></code> builds, each installed prerequisite, which is located in its own subdirectory under</p> | |
| <ul class="simple"> | |
| <li><p><code class="docutils literal notranslate"><span class="pre">C:\simopenpass\deps\thirdParty</span></code> for Windows and</p></li> | |
| <li><p><code class="docutils literal notranslate"><span class="pre">~/simopenpass/deps/thirdParty</span></code> for Linux,</p></li> | |
| </ul> | |
| <p>can be referenced by its path. | |
| The reference is made via the <a class="reference internal" href="further_guidance/10_cmake.html#cmake-prefix-path"><span class="std std-ref">CMAKE_PREFIX_PATH</span></a> environmental variable, which holds a list of directories specifying the installed prerequisite. | |
| This will be explained in more detail in the following.</p> | |
| </li> | |
| <li><p>Navigate back into repository</p> | |
| <div class="sphinx-tabs docutils container"> | |
| <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-4-4-0" aria-selected="true" class="sphinx-tabs-tab" id="tab-4-4-0" name="4-0" role="tab" tabindex="0">Windows</button><button aria-controls="panel-4-4-1" aria-selected="false" class="sphinx-tabs-tab" id="tab-4-4-1" name="4-1" role="tab" tabindex="-1">Linux</button></div><div aria-labelledby="tab-4-4-0" class="sphinx-tabs-panel" id="panel-4-4-0" name="4-0" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">/</span><span class="n">C</span><span class="o">/</span><span class="n">simopenpass</span> | |
| </pre></div> | |
| </div> | |
| </div><div aria-labelledby="tab-4-4-1" class="sphinx-tabs-panel" hidden="true" id="panel-4-4-1" name="4-1" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="o">~/</span><span class="n">simopenpass</span> | |
| </pre></div> | |
| </div> | |
| </div></div> | |
| </li> | |
| <li><p>Create build directory and navigate into it</p> | |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">mkdir</span> <span class="n">build</span> | |
| <span class="n">cd</span> <span class="n">build</span> | |
| </pre></div> | |
| </div> | |
| </li> | |
| <li><p>Prepare build</p> | |
| <p><strong>OpenPASS</strong> links against shared libraries, which are located in the paths specified by <code class="docutils literal notranslate"><span class="pre">CMAKE_PREFIX_PATH</span></code>. | |
| To be able to install <strong>OpenPASS</strong> with resolved dependencies, all libraries found under the paths have to be copied right next to the executable during the installation step. | |
| This is done by setting <code class="docutils literal notranslate"><span class="pre">INSTALL_EXTRA_RUNTIME_DEPS=ON</span></code>. If you have followed the instructions strictly, no changes are necessary.</p> | |
| <div class="sphinx-tabs docutils container"> | |
| <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-5-5-0" aria-selected="true" class="sphinx-tabs-tab" id="tab-5-5-0" name="5-0" role="tab" tabindex="0">Windows</button><button aria-controls="panel-5-5-1" aria-selected="false" class="sphinx-tabs-tab" id="tab-5-5-1" name="5-1" role="tab" tabindex="-1">Linux</button></div><div aria-labelledby="tab-5-5-0" class="sphinx-tabs-panel" id="panel-5-5-0" name="5-0" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cmake</span> <span class="o">-</span><span class="n">G</span> <span class="s2">"MSYS Makefiles"</span> \ | |
| <span class="o">-</span><span class="n">D</span> <span class="n">CMAKE_PREFIX_PATH</span><span class="o">=</span><span class="s2">"C:/msys64/mingw64/bin;C:/simopenpass/deps/thirdParty/FMILibrary;C:/simopenpass/deps/thirdParty/osi"</span> \ | |
| <span class="o">-</span><span class="n">D</span> <span class="n">CMAKE_INSTALL_PREFIX</span><span class="o">=</span><span class="n">C</span><span class="p">:</span><span class="o">/</span><span class="n">OpenPASS</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">core</span> \ | |
| <span class="o">-</span><span class="n">D</span> <span class="n">CMAKE_BUILD_TYPE</span><span class="o">=</span><span class="n">Release</span> \ | |
| <span class="o">-</span><span class="n">D</span> <span class="n">USE_CCACHE</span><span class="o">=</span><span class="n">ON</span> \ | |
| <span class="o">-</span><span class="n">D</span> <span class="n">WITH_DEBUG_POSTFIX</span><span class="o">=</span><span class="n">OFF</span> \ | |
| <span class="o">-</span><span class="n">D</span> <span class="n">OPENPASS_ADJUST_OUTPUT</span><span class="o">=</span><span class="n">OFF</span> \ | |
| <span class="o">-</span><span class="n">D</span> <span class="n">INSTALL_EXTRA_RUNTIME_DEPS</span><span class="o">=</span><span class="n">ON</span> \ | |
| <span class="o">-</span><span class="n">D</span> <span class="n">CMAKE_C_COMPILER</span><span class="o">=</span><span class="n">gcc</span> \ | |
| <span class="o">-</span><span class="n">D</span> <span class="n">CMAKE_CXX_COMPILER</span><span class="o">=</span><span class="n">g</span><span class="o">++</span> \ | |
| <span class="o">..</span> | |
| </pre></div> | |
| </div> | |
| <div class="admonition note"> | |
| <p class="admonition-title">Note</p> | |
| <p>Even though it is recommended, you do not have to copy <a class="reference internal" href="../other_information/20_glossary.html#term-MinGW"><span class="xref std std-term">MinGW</span></a> libraries next to the executable. Providing the libraries can also be done in the following ways:</p> | |
| <ul> | |
| <li><p>either <strong>openPASS</strong> gets <strong>only</strong> executed exclusively from the <code class="docutils literal notranslate"><span class="pre">MinGW</span> <span class="pre">64-bit</span></code> shell, then all necessary <a class="reference internal" href="../other_information/20_glossary.html#term-MinGW"><span class="xref std std-term">MinGW</span></a> libraries get linked automatically by the shell</p></li> | |
| <li><p>or one can add <code class="docutils literal notranslate"><span class="pre">C:\msys64\mingw64\bin</span></code> permanently to the <em>Windows Environment Variable</em> <code class="docutils literal notranslate"><span class="pre">Path</span></code></p></li> | |
| <li><p>or temporarily set <code class="docutils literal notranslate"><span class="pre">Path</span></code> prior to the execution, e.g. in a wrapper:</p> | |
| <div class="highlight-batch notranslate"><div class="highlight"><pre><span></span># your_program.cmd | |
| <span class="k">Path</span>=C:\msys64\mingw64\bin;<span class="nv">%Path%</span> # set Path | |
| your_program.exe # execute | |
| </pre></div> | |
| </div> | |
| </li> | |
| </ul> | |
| </div> | |
| </div><div aria-labelledby="tab-5-5-1" class="sphinx-tabs-panel" hidden="true" id="panel-5-5-1" name="5-1" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cmake</span> <span class="o">-</span><span class="n">D</span> <span class="n">CMAKE_PREFIX_PATH</span><span class="o">=</span><span class="s2">"$HOME/simopenpass/deps/thirdParty/FMILibrary;$HOME/simopenpass/deps/thirdParty/osi"</span> \ | |
| <span class="o">-</span><span class="n">D</span> <span class="n">CMAKE_INSTALL_PREFIX</span><span class="o">=/</span><span class="n">usr</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">OpenPASS</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">core</span> \ | |
| <span class="o">-</span><span class="n">D</span> <span class="n">CMAKE_BUILD_TYPE</span><span class="o">=</span><span class="n">Release</span> \ | |
| <span class="o">-</span><span class="n">D</span> <span class="n">USE_CCACHE</span><span class="o">=</span><span class="n">ON</span> \ | |
| <span class="o">-</span><span class="n">D</span> <span class="n">WITH_DEBUG_POSTFIX</span><span class="o">=</span><span class="n">OFF</span> \ | |
| <span class="o">-</span><span class="n">D</span> <span class="n">OPENPASS_ADJUST_OUTPUT</span><span class="o">=</span><span class="n">OFF</span> \ | |
| <span class="o">-</span><span class="n">D</span> <span class="n">INSTALL_EXTRA_RUNTIME_DEPS</span><span class="o">=</span><span class="n">ON</span> \ | |
| <span class="o">-</span><span class="n">D</span> <span class="n">CMAKE_C_COMPILER</span><span class="o">=</span><span class="n">gcc</span><span class="o">-</span><span class="mi">9</span> \ | |
| <span class="o">-</span><span class="n">D</span> <span class="n">CMAKE_CXX_COMPILER</span><span class="o">=</span><span class="n">g</span><span class="o">++-</span><span class="mi">9</span> \ | |
| <span class="o">..</span> | |
| </pre></div> | |
| </div> | |
| </div></div> | |
| <div class="admonition note"> | |
| <p class="admonition-title">Note</p> | |
| <p>If you need to adjust paths and options based on your system and needs, don’t forget to escape the semicolon <code class="docutils literal notranslate"><span class="pre">;</span></code> (see <a class="reference internal" href="further_guidance/10_cmake.html#cmake-prefix-path"><span class="std std-ref">CMAKE_PREFIX_PATH</span></a>). | |
| For a build that goes beyond the default settings, see <a class="reference internal" href="further_guidance/10_cmake.html#cmake"><span class="std std-ref">CMake Variables and Options</span></a> for more available variables and options that can be set.</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-default notranslate"><div class="highlight"><pre><span></span><span class="n">make</span> <span class="n">test</span> <span class="n">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 documentation</p> | |
| <p>Starting from <code class="docutils literal notranslate"><span class="pre">simopenpass/build</span></code>:</p> | |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">make</span> <span class="n">doc</span> | |
| </pre></div> | |
| </div> | |
| <div class="admonition note"> | |
| <p class="admonition-title">Note</p> | |
| <p>Currently the documentation must be built before <strong>openPASS</strong> can be successfully installed if the CMake variable <cite>WITH_DOC=ON</cite> (default).</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-default notranslate"><div class="highlight"><pre><span></span><span class="n">make</span> <span class="o">-</span><span class="n">j3</span> <span class="n">install</span> | |
| </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-6-6-0" aria-selected="true" class="sphinx-tabs-tab" id="tab-6-6-0" name="6-0" role="tab" tabindex="0">Windows</button><button aria-controls="panel-6-6-1" aria-selected="false" class="sphinx-tabs-tab" id="tab-6-6-1" name="6-1" role="tab" tabindex="-1">Linux</button></div><div aria-labelledby="tab-6-6-0" class="sphinx-tabs-panel" id="panel-6-6-0" name="6-0" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cp</span> <span class="o">/</span><span class="n">C</span><span class="o">/</span><span class="n">OpenPASS</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">core</span><span class="o">/</span><span class="nb">bin</span><span class="o">/*</span> <span class="o">/</span><span class="n">C</span><span class="o">/</span><span class="n">OpenPASS</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">core</span> | |
| </pre></div> | |
| </div> | |
| </div><div aria-labelledby="tab-6-6-1" class="sphinx-tabs-panel" hidden="true" id="panel-6-6-1" name="6-1" role="tabpanel" tabindex="0"><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cp</span> <span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">OpenPASS</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">core</span><span class="o">/</span><span class="nb">bin</span><span class="o">/*</span> <span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">OpenPASS</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">core</span> | |
| </pre></div> | |
| </div> | |
| </div></div> | |
| </li> | |
| </ol> | |
| </div> | |
| </div> | |
| </div> | |
| <footer> | |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | |
| <a href="50_further_guidance.html" class="btn btn-neutral float-right" title="Further Guidance" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> | |
| <a href="20_install_prerequisites.html" class="btn btn-neutral float-left" title="Installing Prerequisites" 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> |