| <!DOCTYPE html> |
| <html class="writer-html5" lang="en" > |
| <head> |
| <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <title>Getting Started — 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="Installing Prerequisites" href="20_install_prerequisites.html" /> |
| <link rel="prev" title="OpenPASS Documentation" href="../index.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.9.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="Navigation menu"> |
| <p class="caption" role="heading"><span class="caption-text">Installation Guide</span></p> |
| <ul class="current"> |
| <li class="toctree-l1 current"><a class="current reference internal" href="#">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"><a class="reference internal" href="30_install_openpass.html">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" 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="../index.html">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="../index.html" class="icon icon-home"></a> »</li> |
| <li>Getting Started</li> |
| <li class="wy-breadcrumbs-aside"> |
| <a href="../_sources/installation_guide/10_getting_started.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"> |
| |
| <section id="getting-started"> |
| <span id="sim-install-guide"></span><h1>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline"></a></h1> |
| <p>Your first step to get <strong>openPASS</strong> up and running is the installation. You can install the <strong>openPASS</strong> simulator on Windows and Linux.</p> |
| <p>The installation manual is structured as follows:</p> |
| <p><strong>Setting up your system</strong></p> |
| <ul class="simple"> |
| <li><p><a class="reference internal" href="20_install_prerequisites.html#prerequisites"><span class="std std-ref">Installing Prerequisites</span></a> contains instructions for installing the thirdparty software required by <strong>openPASS</strong></p></li> |
| </ul> |
| <p><strong>Installation of the simulator</strong></p> |
| <ul class="simple"> |
| <li><p><a class="reference internal" href="30_install_openpass.html#download-and-install-openpass"><span class="std std-ref">Installing OpenPASS</span></a> describes how to compile and run <strong>openPASS</strong> once all prerequisites are installed</p></li> |
| </ul> |
| <p><strong>Run a default simulation</strong></p> |
| <ul class="simple"> |
| <li><p><a class="reference internal" href="../user_guide/20_tutorials.html#tutorials"><span class="std std-ref">Tutorials</span></a> shows how to run your first simulations</p></li> |
| </ul> |
| <p><strong>Further guidance</strong></p> |
| <ul class="simple"> |
| <li><p><a class="reference internal" href="further_guidance/10_cmake.html#cmake"><span class="std std-ref">CMake Variables and Options</span></a> holds information about available variables and options for the cross-platform build environment CMake</p></li> |
| <li><p><a class="reference internal" href="../developer_information/ide_support/20_qt_creator.html#qtcreator"><span class="std std-ref">Working with Qt Creator</span></a> describes the basic setup for QtCreator</p></li> |
| <li><p><a class="reference internal" href="../developer_information/ide_support/30_vscode.html#vscode"><span class="std std-ref">Working with Visual Studio Code</span></a> describes the basic setup for Visual Studio Code</p></li> |
| <li><p><a class="reference internal" href="further_guidance/40_custom_proto.html#building-protobuf"><span class="std std-ref">Custom Protobuf Build</span></a> shows how to compile different versions of Protobuf and hook it into the <strong>openPASS</strong> build</p></li> |
| </ul> |
| </section> |
| |
| |
| </div> |
| </div> |
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
| <a href="../index.html" class="btn btn-neutral float-left" title="OpenPASS Documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| <a href="20_install_prerequisites.html" class="btn btn-neutral float-right" title="Installing Prerequisites" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |
| </div> |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p>© Copyright 2022 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> |