<!-- Generated by pkgdown: do not edit by hand -->
<!DOCTYPE html>
<html lang="en">
  <head>
  <meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>ClusterFunctions for SGE Systems — makeClusterFunctionsSGE • batchtools</title>


<!-- jquery -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script>
<!-- Bootstrap -->

<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" crossorigin="anonymous" />

<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script>

<!-- bootstrap-toc -->
<link rel="stylesheet" href="../bootstrap-toc.css">
<script src="../bootstrap-toc.js"></script>

<!-- Font Awesome icons -->
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous" />

<!-- clipboard.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script>

<!-- headroom.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script>

<!-- pkgdown -->
<link href="../pkgdown.css" rel="stylesheet">
<script src="../pkgdown.js"></script>




<meta property="og:title" content="ClusterFunctions for SGE Systems — makeClusterFunctionsSGE" />
<meta property="og:description" content="Cluster functions for Univa Grid Engine / Oracle Grid Engine /
Sun Grid Engine (https://www.univa.com/).
Job files are created based on the brew template template. This
file is processed with brew and then submitted to the queue using the
qsub command. Jobs are killed using the qdel command and the
list of running jobs is retrieved using qselect. The user must have
the appropriate privileges to submit, delete and list jobs on the cluster
(this is usually the case).
The template file can access all resources passed to submitJobs
as well as all variables stored in the JobCollection.
It is the template file's job to choose a queue for the job and handle the desired resource
allocations." />




<!-- mathjax -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script>

<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->



  </head>

  <body data-spy="scroll" data-target="#toc">
    <div class="container template-reference-topic">
      <header>
      <div class="navbar navbar-default navbar-fixed-top" role="navigation">
  <div class="container">
    <div class="navbar-header">
      <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
        <span class="sr-only">Toggle navigation</span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
      </button>
      <span class="navbar-brand">
        <a class="navbar-link" href="../index.html">batchtools</a>
        <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">0.9.14</span>
      </span>
    </div>

    <div id="navbar" class="navbar-collapse collapse">
      <ul class="nav navbar-nav">
        <li>
  <a href="../index.html">
    <span class="fas fa fas fa-home fa-lg"></span>
     
  </a>
</li>
<li>
  <a href="../articles/batchtools.html">Get started</a>
</li>
<li>
  <a href="../reference/index.html">Reference</a>
</li>
<li>
  <a href="../news/index.html">Changelog</a>
</li>
      </ul>
      <ul class="nav navbar-nav navbar-right">
        <li>
  <a href="https://github.com/mllg/batchtools/">
    <span class="fab fa fab fa-github fa-lg"></span>
     
  </a>
</li>
      </ul>
      
    </div><!--/.nav-collapse -->
  </div><!--/.container -->
</div><!--/.navbar -->

      

      </header>

<div class="row">
  <div class="col-md-9 contents">
    <div class="page-header">
    <h1>ClusterFunctions for SGE Systems</h1>
    <small class="dont-index">Source: <a href='https://github.com/mllg/batchtools/blob/master/R/clusterFunctionsSGE.R'><code>R/clusterFunctionsSGE.R</code></a></small>
    <div class="hidden name"><code>makeClusterFunctionsSGE.Rd</code></div>
    </div>

    <div class="ref-description">
    <p>Cluster functions for Univa Grid Engine / Oracle Grid Engine /
Sun Grid Engine (<a href='https://www.univa.com/'>https://www.univa.com/</a>).</p>
<p>Job files are created based on the brew template <code>template</code>. This
file is processed with brew and then submitted to the queue using the
<code>qsub</code> command. Jobs are killed using the <code>qdel</code> command and the
list of running jobs is retrieved using <code>qselect</code>. The user must have
the appropriate privileges to submit, delete and list jobs on the cluster
(this is usually the case).</p>
<p>The template file can access all resources passed to <code><a href='submitJobs.html'>submitJobs</a></code>
as well as all variables stored in the <code><a href='makeJobCollection.html'>JobCollection</a></code>.
It is the template file's job to choose a queue for the job and handle the desired resource
allocations.</p>
    </div>

    <pre class="usage"><span class='fu'>makeClusterFunctionsSGE</span><span class='op'>(</span>
  template <span class='op'>=</span> <span class='st'>"sge"</span>,
  nodename <span class='op'>=</span> <span class='st'>"localhost"</span>,
  scheduler.latency <span class='op'>=</span> <span class='fl'>1</span>,
  fs.latency <span class='op'>=</span> <span class='fl'>65</span>
<span class='op'>)</span></pre>

    <h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a>Arguments</h2>
    <table class="ref-arguments">
    <colgroup><col class="name" /><col class="desc" /></colgroup>
    <tr>
      <th>template</th>
      <td><p>[<code><a href='https://rdrr.io/r/base/character.html'>character(1)</a></code>]<br />
Either a path to a <span class="pkg">brew</span> template file (with extension &#8220;tmpl&#8221;), or a short descriptive name enabling the following heuristic for the file lookup:</p><ol>
<li><p>&#8220;batchtools.[template].tmpl&#8221; in the path specified by the environment variable &#8220;R_BATCHTOOLS_SEARCH_PATH&#8221;.</p></li>
<li><p>&#8220;batchtools.[template].tmpl&#8221; in the current working directory.</p></li>
<li><p>&#8220;[template].tmpl&#8221; in the user config directory (see <code><a href='https://rdrr.io/pkg/rappdirs/man/user_data_dir.html'>user_config_dir</a></code>); on linux this is usually &#8220;~/.config/batchtools/[template].tmpl&#8221;.</p></li>
<li><p>&#8220;.batchtools.[template].tmpl&#8221; in the home directory.</p></li>
<li><p>&#8220;[template].tmpl&#8221; in the package installation directory in the subfolder &#8220;templates&#8221;.</p></li>
</ol></td>
    </tr>
    <tr>
      <th>nodename</th>
      <td><p>[<code><a href='https://rdrr.io/r/base/character.html'>character(1)</a></code>]<br />
Nodename of the master host. All commands are send via SSH to this host. Only works iff</p><ol>
<li><p>Passwordless authentication (e.g., via SSH public key authentication) is set up.</p></li>
<li><p>The file directory is shared across machines, e.g. mounted via SSHFS.</p></li>
<li><p>Either the absolute path to the <code>file.dir</code> is identical on the machines, or paths are provided relative to the home directory. Symbolic links should work.</p></li>
</ol></td>
    </tr>
    <tr>
      <th>scheduler.latency</th>
      <td><p>[<code><a href='https://rdrr.io/r/base/numeric.html'>numeric(1)</a></code>]<br />
Time to sleep after important interactions with the scheduler to ensure a sane state.
Currently only triggered after calling <code><a href='submitJobs.html'>submitJobs</a></code>.</p></td>
    </tr>
    <tr>
      <th>fs.latency</th>
      <td><p>[<code><a href='https://rdrr.io/r/base/numeric.html'>numeric(1)</a></code>]<br />
Expected maximum latency of the file system, in seconds.
Set to a positive number for network file systems like NFS which enables more robust (but also more expensive) mechanisms to
access files and directories.
Usually safe to set to <code>0</code> to disable the heuristic, e.g. if you are working on a local file system.</p></td>
    </tr>
    </table>

    <h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>

    <p>[<code><a href='makeClusterFunctions.html'>ClusterFunctions</a></code>].</p>
    <h2 class="hasAnchor" id="note"><a class="anchor" href="#note"></a>Note</h2>

    <p>Array jobs are currently not supported.</p>
    <h2 class="hasAnchor" id="see-also"><a class="anchor" href="#see-also"></a>See also</h2>

    <div class='dont-index'><p>Other ClusterFunctions: 
<code><a href='makeClusterFunctionsDocker.html'>makeClusterFunctionsDocker</a>()</code>,
<code><a href='makeClusterFunctionsInteractive.html'>makeClusterFunctionsInteractive</a>()</code>,
<code><a href='makeClusterFunctionsLSF.html'>makeClusterFunctionsLSF</a>()</code>,
<code><a href='makeClusterFunctionsMulticore.html'>makeClusterFunctionsMulticore</a>()</code>,
<code><a href='makeClusterFunctionsOpenLava.html'>makeClusterFunctionsOpenLava</a>()</code>,
<code><a href='makeClusterFunctionsSSH.html'>makeClusterFunctionsSSH</a>()</code>,
<code><a href='makeClusterFunctionsSlurm.html'>makeClusterFunctionsSlurm</a>()</code>,
<code><a href='makeClusterFunctionsSocket.html'>makeClusterFunctionsSocket</a>()</code>,
<code><a href='makeClusterFunctionsTORQUE.html'>makeClusterFunctionsTORQUE</a>()</code>,
<code><a href='makeClusterFunctions.html'>makeClusterFunctions</a>()</code></p></div>

  </div>
  <div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
    <nav id="toc" data-toggle="toc" class="sticky-top">
      <h2 data-toc-skip>Contents</h2>
    </nav>
  </div>
</div>


      <footer>
      <div class="copyright">
  <p>Developed by Michel Lang, Bernd Bischl.</p>
</div>

<div class="pkgdown">
  <p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.6.1.</p>
</div>

      </footer>
   </div>

  


  </body>
</html>


