206 lines
12 KiB
HTML
206 lines
12 KiB
HTML
<!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>4. Installing PRRTE — PMIx Reference Run Time Environment 3.0.8 documentation</title>
|
||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||
<link rel="stylesheet" type="text/css" href="_static/css/theme.css" />
|
||
|
||
|
||
<!--[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/_sphinx_javascript_frameworks_compat.js"></script>
|
||
<script src="_static/doctools.js"></script>
|
||
<script src="_static/sphinx_highlight.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="5. PRRTE DVM Configuration" href="configuration.html" />
|
||
<link rel="prev" title="3. Getting help" href="getting-help.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">
|
||
PMIx Reference Run Time Environment
|
||
</a>
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" aria-label="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">
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">1. Quick start</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="release-notes.html">2. Release Notes</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="getting-help.html">3. Getting help</a></li>
|
||
<li class="toctree-l1 current"><a class="current reference internal" href="#">4. Installing PRRTE</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="#for-more-information">4.1. For More Information</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#minimum-pmix-version">4.2. Minimum PMIx version</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#developer-builds">4.3. Developer Builds</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#user-builds">4.4. User Builds</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="configuration.html">5. PRRTE DVM Configuration</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="how-things-work/index.html">6. How Things Work</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="hosts/index.html">7. Host specification</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="placement/index.html">8. Process placement</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="notifications.html">9. Notifications</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="session-directory.html">10. Session directory</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="developers/index.html">11. Developer’s guide</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">12. Contributing to PRRTE</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="license.html">13. License</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="man/index.html">14. PRRTE manual pages</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="versions.html">15. Software Version Numbers</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="news/index.html">16. News</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">PMIx Reference Run Time Environment</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" aria-label="Home"></a></li>
|
||
<li class="breadcrumb-item active"><span class="section-number">4. </span>Installing PRRTE</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
<a href="_sources/install.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">
|
||
|
||
<style>
|
||
.wy-table-responsive table td,.wy-table-responsive table th{white-space:normal}
|
||
</style><div class="section" id="installing-prrte">
|
||
<h1><span class="section-number">4. </span>Installing PRRTE<a class="headerlink" href="#installing-prrte" title="Permalink to this heading"></a></h1>
|
||
<div class="section" id="for-more-information">
|
||
<h2><span class="section-number">4.1. </span>For More Information<a class="headerlink" href="#for-more-information" title="Permalink to this heading"></a></h2>
|
||
<p>This file is a <em>very</em> short overview of building and installing the
|
||
PMIx Reference RunTime Environment (PRRTE). More information is
|
||
available <a class="reference external" href="https://github.com/openpmix/prrte">in the FAQ section on the PRRTE web site</a>.</p>
|
||
</div>
|
||
<div class="section" id="minimum-pmix-version">
|
||
<h2><span class="section-number">4.2. </span>Minimum PMIx version<a class="headerlink" href="#minimum-pmix-version" title="Permalink to this heading"></a></h2>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">configure</span></code> script in PRRTE v3.0.8 must be able to find an
|
||
OpenPMIx installation that is 4.2.4 or higher. If
|
||
<code class="docutils literal notranslate"><span class="pre">configure</span></code> cannot find a suitable OpenPMIx version, it will abort
|
||
with an error.</p>
|
||
<p>If OpenPMIx cannot be found in default preprocessor and linker search
|
||
paths, you can specify the <code class="docutils literal notranslate"><span class="pre">--with-pmix=DIR</span></code> CLI option to tell
|
||
<code class="docutils literal notranslate"><span class="pre">configure</span></code> where to find it.</p>
|
||
</div>
|
||
<div class="section" id="developer-builds">
|
||
<h2><span class="section-number">4.3. </span>Developer Builds<a class="headerlink" href="#developer-builds" title="Permalink to this heading"></a></h2>
|
||
<p>If you have checked out a DEVELOPER’S COPY of PRRTE (i.e., you checked
|
||
out from Git), you should read the <a class="reference internal" href="developers/index.html"><span class="doc">Developer’s Guide</span></a> section before attempting to build PRRTE. You
|
||
must then run:</p>
|
||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>shell$<span class="w"> </span>./autogen.pl
|
||
</pre></div>
|
||
</div>
|
||
<p>You will need very recent versions of GNU Autoconf, Automake, and
|
||
Libtool. If <code class="docutils literal notranslate"><span class="pre">autogen.pl</span></code> fails, read the <a class="reference internal" href="developers/index.html"><span class="doc">Developer’s Guide</span></a>. If anything else fails, read the
|
||
<a class="reference internal" href="developers/index.html"><span class="doc">Developer’s Guide</span></a>. Finally, we suggest
|
||
reading the <a class="reference internal" href="developers/index.html"><span class="doc">Developer’s Guide</span></a>.</p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>Developer’s copies of PRRTE typically include a large
|
||
performance penalty at run-time because of extra debugging
|
||
overhead.</p>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="user-builds">
|
||
<h2><span class="section-number">4.4. </span>User Builds<a class="headerlink" href="#user-builds" title="Permalink to this heading"></a></h2>
|
||
<p>Building PRRTE is typically a combination of running <code class="docutils literal notranslate"><span class="pre">configure</span></code>
|
||
and <code class="docutils literal notranslate"><span class="pre">make</span></code>. Execute the following commands to install the PRRTE
|
||
system from within the directory at the top of the tree:</p>
|
||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>shell$<span class="w"> </span>./configure<span class="w"> </span>--prefix<span class="o">=</span>/where/to/install
|
||
<span class="o">[</span>...lots<span class="w"> </span>of<span class="w"> </span>output...<span class="o">]</span>
|
||
shell$<span class="w"> </span>make<span class="w"> </span>all<span class="w"> </span>install
|
||
</pre></div>
|
||
</div>
|
||
<p>If you need special access to install, then you can execute <code class="docutils literal notranslate"><span class="pre">make</span>
|
||
<span class="pre">all</span></code> as a user with write permissions in the build tree, and a
|
||
separate <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">install</span></code> as a user with write permissions to the
|
||
install tree.</p>
|
||
<p>Compiling support for specific compilers and environments may require
|
||
additional command line flags when running <code class="docutils literal notranslate"><span class="pre">configure</span></code>. Note that
|
||
VPATH builds are fully supported. For example:</p>
|
||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>shell$<span class="w"> </span>tar<span class="w"> </span>xf<span class="w"> </span>prrte-X.Y.Z.tar.gz
|
||
shell$<span class="w"> </span><span class="nb">cd</span><span class="w"> </span>prrte-X.Y.Z
|
||
shell$<span class="w"> </span>mkdir<span class="w"> </span>build
|
||
shell$<span class="w"> </span><span class="nb">cd</span><span class="w"> </span>build
|
||
shell$<span class="w"> </span>../configure<span class="w"> </span>...your<span class="w"> </span>options...
|
||
<span class="o">[</span>...lots<span class="w"> </span>of<span class="w"> </span>output...<span class="o">]</span>
|
||
shell$<span class="w"> </span>make<span class="w"> </span>all<span class="w"> </span>install
|
||
</pre></div>
|
||
</div>
|
||
<p>Parallel builds are also supported (although some versions of <code class="docutils literal notranslate"><span class="pre">make</span></code>,
|
||
such as GNU make, will only use the first target listed on the command
|
||
line when executable parallel builds). For example (assume GNU make):</p>
|
||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>shell$<span class="w"> </span>make<span class="w"> </span>-j<span class="w"> </span><span class="m">4</span><span class="w"> </span>all
|
||
<span class="o">[</span>...lots<span class="w"> </span>of<span class="w"> </span>output...<span class="o">]</span>
|
||
shell$<span class="w"> </span>make<span class="w"> </span>install
|
||
</pre></div>
|
||
</div>
|
||
<p>Parallel make is generally only helpful in the build phase; the
|
||
installation process is mostly serial and does not benefit much from
|
||
parallel make.</p>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
<a href="getting-help.html" class="btn btn-neutral float-left" title="3. Getting help" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||
<a href="configuration.html" class="btn btn-neutral float-right" title="5. PRRTE DVM Configuration" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>© Copyright 2003-2025, The PRRTE Community.</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> |