Page History

<div class="section" id="defining-a-new-suite">
<span id="defining-a-suite"></span><span id="index-0"></span>
<p>Create a file called <tt class="file docutils literal"><span class="pre">test.def</span></tt> with the following contents: (not the line numbers)</p>
<div class="highlight-python"><pre>1 # Definition of the suite test
2
3 suite test
4     edit ECF_HOME "$HOME/course"  # replace '$HOME' with the path to your home directory
5     task t1
6 endsuite</pre>
</div>
<p>This file contains the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-suite-definition"><em class="xref std std-term">suite definition</em></a> of a <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-suite"><em class="xref std std-term">suite</em></a> called test.
This suite contains a single <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-task"><em class="xref std std-term">task</em></a> called <strong>t1</strong>.
Let us go through the lines one by one:</p>
<ol class="arabic">
<li><p class="first">This line is a comment line. Any characters between the # and the end of line are ignored</p>
</li>
<li><p class="first">The second line is empty</p>
</li>
<li><p class="first">This line defines a new <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-suite"><em class="xref std std-term">suite</em></a> by the name of test.</p>
</li>
<li><p class="first">Here we define a ECF <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-variable"><em class="xref std std-term">variable</em></a> called ECF_HOME.</p>
<p>This <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-variable"><em class="xref std std-term">variable</em></a> defines the directory where all the unix files that will be used by the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-suite"><em class="xref std std-term">suite</em></a> test will reside.</p>
<p>For the rest of the course all file names will be given relative to this directory.</p>
<p>Be sure to <strong>replace</strong> $HOME with the path to your home directory</p>
</li>
<li><p class="first">This defines a <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-task"><em class="xref std std-term">task</em></a> named <strong>t1</strong></p>
</li>
<li><p class="first">The <a class="reference internal" href="/wiki/display/ECFLOW/Definition+file+Grammer#grammar-token-endsuite"><tt class="xref std std-token docutils literal"><span class="pre">endsuite</span></tt></a> finishes the definition of the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-suite"><em class="xref std std-term">suite</em></a> test</p>
</li>
</ol>
<p>Alternatively enter the following python code:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="c">#!/usr/bin/env python2.5</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">ecflow</span> 
   
<span class="n">defs</span> <span class="o">=</span> <span class="n">ecflow</span><span class="o">.</span><span class="n">Defs</span><span class="p">(</span><span class="s">&quot;test.def&quot;</span><span class="p">)</span>
<span class="n">suite</span> <span class="o">=</span> <span class="n">defs</span><span class="o">.</span><span class="n">add_suite</span><span class="p">(</span><span class="s">&quot;test&quot;</span><span class="p">)</span>
<span class="n">suite</span><span class="o">.</span><span class="n">add_variable</span><span class="p">(</span><span class="s">&quot;ECF_HOME&quot;</span><span class="p">,</span><span class="n">os</span><span class="o">.</span><span class="n">getenv</span><span class="p">(</span><span class="s">&quot;HOME&quot;</span><span class="p">)</span> <span class="o">+</span> <span class="s">&quot;/course&quot;</span><span class="p">)</span>
<span class="n">suite</span><span class="o">.</span><span class="n">add_task</span><span class="p">(</span><span class="s">&quot;t1&quot;</span><span class="p">)</span>
</pre></div>
</div>
<p>What to do</p>
<ol class="arabic simple">
<li>Choose between entering plain text or python</li>
<li>Type in the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-suite-definition"><em class="xref std std-term">suite definition</em></a> file. Do not type the line numbers!</li>
</ol>
</div>