installation.html

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
  <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>Installation &mdash; grid-control  documentation</title>
      <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
      <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  <!--[if lt IE 9]>
    <script src="_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
        <script src="_static/jquery.js?v=5d32c60e"></script>
        <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
        <script src="_static/documentation_options.js?v=5929fcd5"></script>
        <script src="_static/doctools.js?v=9a2dae69"></script>
        <script src="_static/sphinx_highlight.js?v=dc90522c"></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="Getting started" href="getting_started.html" />
    <link rel="prev" title="grid-control user’s guide" 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">
            grid-control
          </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">
              <p class="caption" role="heading"><span class="caption-text">Contents</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#requirements">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="#installation-from-pypi-pip">Installation from PyPI (<code class="docutils literal notranslate"><span class="pre">pip</span></code>)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#clone-from-git">Clone from git</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#switch-to-a-different-branch">Switch to a different branch</a></li>
<li class="toctree-l3"><a class="reference internal" href="#pull-remote-changes">Pull remote changes</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a><ul>
<li class="toctree-l2"><a class="reference internal" href="getting_started.html#first-configuration-run-jobs-on-the-local-machine">First configuration (run jobs on the local machine)</a></li>
<li class="toctree-l2"><a class="reference internal" href="getting_started.html#further-examples">Further examples</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="NAF.html">NAF specifics</a><ul>
<li class="toctree-l2"><a class="reference internal" href="NAF.html#central-installation">Central installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="NAF.html#backend">Backend</a></li>
<li class="toctree-l2"><a class="reference internal" href="NAF.html#submitting-to-centos7-nodes">Submitting to CentOS7 nodes</a></li>
<li class="toctree-l2"><a class="reference internal" href="NAF.html#custom-entries-in-condor-submit-file">Custom entries in condor submit file</a></li>
<li class="toctree-l2"><a class="reference internal" href="NAF.html#singularity-virtualization">Singularity (Virtualization)</a></li>
<li class="toctree-l2"><a class="reference internal" href="NAF.html#use-a-voms-proxy">Use a VOMS proxy</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tips_tricks.html">Tips &amp; tricks</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tips_tricks.html#gnu-screen">GNU Screen</a></li>
<li class="toctree-l2"><a class="reference internal" href="tips_tricks.html#global-configuration">Global configuration</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="error_codes.html">Error codes</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">grid-control</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">Installation</li>
      <li class="wy-breadcrumbs-aside">
            <a href="_sources/installation.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="installation">
<h1>Installation<a class="headerlink" href="#installation" title="Link to this heading"></a></h1>
<nav class="contents local" id="contents">
<ul class="simple">
<li><p><a class="reference internal" href="#requirements" id="id2">Requirements</a></p></li>
<li><p><a class="reference internal" href="#installation-from-pypi-pip" id="id3">Installation from PyPI (<code class="docutils literal notranslate"><span class="pre">pip</span></code>)</a></p></li>
<li><p><a class="reference internal" href="#clone-from-git" id="id4">Clone from git</a></p>
<ul>
<li><p><a class="reference internal" href="#switch-to-a-different-branch" id="id5">Switch to a different branch</a></p></li>
<li><p><a class="reference internal" href="#pull-remote-changes" id="id6">Pull remote changes</a></p></li>
</ul>
</li>
</ul>
</nav>
<p><strong>Note</strong>: <em>If you are using grid-control with the NAF, you can use the</em> <a class="reference internal" href="NAF.html#naf-central-inst"><span class="std std-ref">central installation</span></a>.</p>
<section id="requirements">
<h2>Requirements<a class="headerlink" href="#requirements" title="Link to this heading"></a></h2>
<p>Requirements on the submission host:</p>
<ul class="simple">
<li><p>CPython 2.3 – 3.5 / pypy 2.4 – 5.3 with python standard libraries</p></li>
<li><p>(optional) requests – for faster interactions with webservies</p></li>
<li><p>(optional) cherrypy – for web based user interface</p></li>
<li><p>(highly recommended) a supported submission backend (ARC, Condor, CreamCE, glite/-wms, PBS, LSF, SLURM, JMS, GridEngine)</p></li>
</ul>
<p>Requirements on the worker nodes:</p>
<ul class="simple">
<li><p>bash, GNU coreutils, awk, sed</p></li>
<li><p>(optional) gfal / other supported transfer tools – for storage access</p></li>
<li><p>(optional) cvmfs – to allow running the LHC experiment software</p></li>
</ul>
</section>
<section id="installation-from-pypi-pip">
<h2>Installation from PyPI (<code class="docutils literal notranslate"><span class="pre">pip</span></code>)<a class="headerlink" href="#installation-from-pypi-pip" title="Link to this heading"></a></h2>
<p><strong>Note</strong>: <em>Since the PyPI release is rather outdated at the moment, we recommend</em> <a class="reference internal" href="#clone-from-git"><span class="std std-ref">cloning from git</span></a>.</p>
<div class="highlight-shell-session notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>pip<span class="w"> </span>install<span class="w"> </span>--user<span class="w"> </span>grid-control
</pre></div>
</div>
<p>This installs the default <code class="docutils literal notranslate"><span class="pre">go.py</span></code> executable. In addition the executalbe <code class="docutils literal notranslate"><span class="pre">gridcontrol</span></code> is provided, because of the more descriptive name.</p>
</section>
<section id="clone-from-git">
<span id="id1"></span><h2>Clone from git<a class="headerlink" href="#clone-from-git" title="Link to this heading"></a></h2>
<div class="highlight-shell-session notranslate"><div class="highlight"><pre><span></span><span class="gp"># </span>whereever<span class="w"> </span>you<span class="w"> </span>check<span class="w"> </span>out<span class="w"> </span>your<span class="w"> </span>projects
<span class="gp">$ </span><span class="nb">cd</span><span class="w"> </span>&lt;your<span class="w"> </span>project<span class="w"> </span>path&gt;
<span class="gp">$ </span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/grid-control/grid-control.git
<span class="go">Cloning into &#39;grid-control&#39;...</span>
<span class="go">remote: Enumerating objects: 43, done.</span>
<span class="go">remote: Counting objects: 100% (43/43), done.</span>
<span class="go">remote: Compressing objects: 100% (27/27), done.</span>
<span class="go">remote: Total 18566 (delta 26), reused 31 (delta 16), pack-reused 18523</span>
<span class="go">Receiving objects: 100% (18566/18566), 6.39 MiB | 4.70 MiB/s, done.</span>
<span class="go">Resolving deltas: 100% (14715/14715), done.</span>
</pre></div>
</div>
<p>Now one option is to place a link to the executable in a location contained in your <code class="docutils literal notranslate"><span class="pre">PATH</span></code> environment variable.
Assuming <code class="docutils literal notranslate"><span class="pre">~/bin</span></code> is such a location (check with <code class="docutils literal notranslate"><span class="pre">echo</span> <span class="pre">$PATH</span></code>):</p>
<div class="highlight-shell-session notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span><span class="nb">cd</span><span class="w"> </span>~/bin
<span class="gp">$ </span>ln<span class="w"> </span>-s<span class="w"> </span>&lt;your<span class="w"> </span>project<span class="w"> </span>path&gt;/grid-control/go.py<span class="w"> </span>grid-control
</pre></div>
</div>
<p>Now you can use the <code class="docutils literal notranslate"><span class="pre">grid-control</span></code> executable, instead of the standard <code class="docutils literal notranslate"><span class="pre">go.py</span></code>, which is not very descriptive.</p>
<section id="switch-to-a-different-branch">
<h3>Switch to a different branch<a class="headerlink" href="#switch-to-a-different-branch" title="Link to this heading"></a></h3>
<p>Different branches can be used. E.g. <code class="docutils literal notranslate"><span class="pre">testing</span></code> for more up-to-date changes:</p>
<div class="highlight-shell-session notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span><span class="nb">cd</span><span class="w"> </span>&lt;your<span class="w"> </span>project<span class="w"> </span>path&gt;/grid-control
<span class="gp">$ </span>git<span class="w"> </span>checkout<span class="w"> </span>testing
<span class="go">Branch &#39;testing&#39; set up to track remote branch &#39;testing&#39; from &#39;origin&#39;.</span>
<span class="go">Switched to a new branch &#39;testing&#39;</span>
</pre></div>
</div>
</section>
<section id="pull-remote-changes">
<h3>Pull remote changes<a class="headerlink" href="#pull-remote-changes" title="Link to this heading"></a></h3>
<p>Update your version with upstream changes from the current branch (make sure you are on the local branch that you want to update):</p>
<div class="highlight-shell-session notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span><span class="nb">cd</span><span class="w"> </span>&lt;your<span class="w"> </span>project<span class="w"> </span>path&gt;/grid-control
<span class="gp">$ </span>git<span class="w"> </span>pull
<span class="go">Updating 14725499..bb9b2a93</span>
<span class="go">Fast-forward</span>
<span class="go">packages/grid_control/backends/condor_wms/condor_wms.py |  3 ++-</span>
<span class="go">packages/grid_control/backends/wms_condor.py            | 13 +++++++++----</span>
<span class="go">packages/grid_control/share/help.txt                    |  4 ++--</span>
<span class="go">packages/grid_control/utils/webservice_urllib2.py       |  4 +---</span>
<span class="go">packages/grid_control_api.py                            |  4 ++--</span>
<span class="go">5 files changed, 16 insertions(+), 12 deletions(-)</span>
</pre></div>
</div>
</section>
</section>
</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="grid-control user’s guide" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
        <a href="getting_started.html" class="btn btn-neutral float-right" title="Getting started" 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 2019, Johannes Lange.</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(false);
      });
  </script> 

</body>
</html>