<div class="section" id="defining-the-first-task"> <span id="defining-a-task"></span><span id="index-0"></span> <p>Next, we need to write the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecf-script"><em class="xref std std-term">ecf script</em></a> for the task <strong>t1</strong>. By default ECF expects files to be in a directory structure below ECF_HOME that reflect the hierarchy of the suites. The <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-task"><em class="xref std std-term">task</em></a> <strong>t1</strong> being in the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-suite"><em class="xref std std-term">suite</em></a> test, the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecf-script"><em class="xref std std-term">ecf script</em></a> for the task <strong>t1</strong> must be in a sub-directory test.</p> <ul> <li><p class="first">In ECF_HOME, create a directory test:</p> <div class="highlight-python"><pre>> mkdir test</pre> </div> </li> <li><p class="first">In test, create a file name <tt class="file docutils literal"><span class="pre">t1.ecf</span></tt> with the following contents:</p> <div class="highlight-python"><pre>%include "../head.h" echo "I am part of a suite that lives in %ECF_HOME%" %include "../tail.h"</pre> </div> </li> </ul> <p>Although similar an <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecf-script"><em class="xref std std-term">ecf script</em></a> is not a unix script. It contains <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-pre-processing"><em class="xref std std-term">pre-processing</em></a> <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-directives"><em class="xref std std-term">directives</em></a>. Those <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-directives"><em class="xref std std-term">directives</em></a> are specified using the character %. Before submitting the task, the ECF will scan the script and substitute the following strings:</p> <ul class="simple"> <li>%include ”../head.h” will be substituted by the content of the file <a class="reference internal" href="/wiki/display/ECFLOW/Getting+Started#head-h"><em>head.h</em></a>. Note that the file name is given relatively to the file <tt class="file docutils literal"><span class="pre">t1.ecf</span></tt>, i.e. in the directory above the one containing <tt class="file docutils literal"><span class="pre">t1.ecf</span></tt></li> <li>%ECF_HOME% will be substituted by the value of the ECF variable ECF_HOME</li> <li>%include <em>”../tail.h”</em> will be substituted by the content of the file <a class="reference internal" href="/wiki/display/ECFLOW/Getting+Started#tail-h"><em>tail.h</em></a></li> </ul> <p>The output of <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-job-creation"><em class="xref std std-term">job creation</em></a> is known as the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-job-file"><em class="xref std std-term">job file</em></a>, and is usually a unix script, although not necessarily. This is the script that ECF will submit to your system.</p> <p>The workings of the files <a class="reference internal" href="/wiki/display/ECFLOW/Getting+Started#head-h"><em>head.h</em></a> and <a class="reference internal" href="/wiki/display/ECFLOW/Getting+Started#tail-h"><em>tail.h</em></a> are described inline. head.h contains code to set-up the job environment so that it can work with ECF and also includes the required error trapping to report any script errors to the ECF server. The file <a class="reference internal" href="/wiki/display/ECFLOW/Getting+Started#tail-h"><em>tail.h</em></a> contains clean up code.</p> <p>What to do:</p> <ol class="arabic simple"> <li>Type in the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecf-script"><em class="xref std std-term">ecf script</em></a> <tt class="file docutils literal"><span class="pre">t1.ecf</span></tt></li> </ol> </div> |