Page History

Versions Compared

Old Version 15

changes.mady.by.user Daniel Varela Santoalla

Saved on Aug 22, 2011

compared with

New Version Current

changes.mady.by.user Unknown User (ma0)

Saved on Jul 29, 2020

Key

This line was added.
This line was removed.
Formatting was changed.

 Horizontal Navigation Bar

 Button Group
 Button Hyperlink
titlePrevious
typestandard
urlhttps://confluence.ecmwf.int/display/ECFLOW/Understanding+Includes
 Button Hyperlink
titleUp
typestandard
urlhttps://confluence.ecmwf.int/display/ECFLOW/Tutorial
 Button Hyperlink
titleNext
typestandard
urlhttps://confluence.ecmwf.int/display/ECFLOW/Checking+job+creation

Next, we need to write the ecf script for the task t1.
By default ecFlow expects files to be in a directory structure below ECF_HOME
that reflects the hierarchy of the suites. The task t1 being in the suite test,
the ecf script for the task t1 must be in a sub-directory test.

In ECF_HOME, create a directory test:

Code Block

language	bash

mkdir test

In test directory, create a file t1.ecf with the following contents:

Code Block

language	bash
title	$HOME/course/test/t1.ecf

%include "

HTML

<style type="text/css">
.highlight .hll { background-color: #ffffcc }
.highlight  { background: #eeffcc; }
.highlight .c { color: #408090; font-style: italic } /* Comment */
.highlight .err { border: 1px solid #FF0000 } /* Error */
.highlight .k { color: #007020; font-weight: bold } /* Keyword */
.highlight .o { color: #666666 } /* Operator */
.highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */
.highlight .cp { color: #007020 } /* Comment.Preproc */
.highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */
.highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #A00000 } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gr { color: #FF0000 } /* Generic.Error */
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
.highlight .gi { color: #00A000 } /* Generic.Inserted */
.highlight .go { color: #303030 } /* Generic.Output */
.highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
.highlight .gt { color: #0040D0 } /* Generic.Traceback */
.highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #007020 } /* Keyword.Pseudo */
.highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #902000 } /* Keyword.Type */
.highlight .m { color: #208050 } /* Literal.Number */
.highlight .s { color: #4070a0 } /* Literal.String */
.highlight .na { color: #4070a0 } /* Name.Attribute */
.highlight .nb { color: #007020 } /* Name.Builtin */
.highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */
.highlight .no { color: #60add5 } /* Name.Constant */
.highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */
.highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */
.highlight .ne { color: #007020 } /* Name.Exception */
.highlight .nf { color: #06287e } /* Name.Function */
.highlight .nl { color: #002070; font-weight: bold } /* Name.Label */
.highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */
.highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #bb60d5 } /* Name.Variable */
.highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .mf { color: #208050 } /* Literal.Number.Float */
.highlight .mh { color: #208050 } /* Literal.Number.Hex */
.highlight .mi { color: #208050 } /* Literal.Number.Integer */
.highlight .mo { color: #208050 } /* Literal.Number.Oct */
.highlight .sb { color: #4070a0 } /* Literal.String.Backtick */
.highlight .sc { color: #4070a0 } /* Literal.String.Char */
.highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */
.highlight .s2 { color: #4070a0 } /* Literal.String.Double */
.highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */
.highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */
.highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */
.highlight .sx { color: #c65d09 } /* Literal.String.Other */
.highlight .sr { color: #235388 } /* Literal.String.Regex */
.highlight .s1 { color: #4070a0 } /* Literal.String.Single */
.highlight .ss { color: #517918 } /* Literal.String.Symbol */
.highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */
.highlight .vc { color: #bb60d5 } /* Name.Variable.Class */
.highlight .vg { color: #bb60d5 } /* Name.Variable.Global */
.highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */
.highlight .il { color: #208050 } /* Literal.Number.Integer.Long */
</style>


<div class="section" id="defining-the-first-task">
<span id="defining-a-task"></span><span id="index-0"></span>
<div class="line-block">
<div class="line">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>.</div>
<div class="line">By default ECF expects files to be in a directory structure below ECF_HOME</div>
<div class="line">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,</div>
<div class="line">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.</div>
</div>
<ul>
<li><p class="first">In ECF_HOME, create a directory test:</p>
<div class="highlight-python"><pre>&gt; 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>
</div>
<div class="section" id="job-creation">
<span id="id1"></span>
<div class="line-block">
<div class="line">Before submitting the task, the server will transform the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecf-script"><em class="xref std std-term">ecf script</em></a> to a <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-job-file"><em class="xref std std-term">job file</em></a></div>
<div class="line">This process is known as <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-job-creation"><em class="xref std std-term">job creation</em></a>.</div>
</div>
<div class="line-block">
<div class="line">This involves locating the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecf-script"><em class="xref std std-term">ecf script</em></a> on disk, and then <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-pre-processing"><em class="xref std std-term">pre-processing</em></a> the</div>
<div class="line"><a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-directives"><em class="xref std std-term">directives</em></a>. This process includes performing <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-variable-substitution"><em class="xref std std-term">variable substitution</em></a>.</div>
</div>
<div class="line-block">
<div class="line">This will create a file with a &#8216;.job&#8217; extension.</div>
<div class="line">This is the script that ECF will submit to your system.</div>
</div>
<p>In our case:</p>
<ul>
<li><p class="first">%include &#8221;../head.h&#8221; will be substituted by the content of the file <a class="reference internal" href="/wiki/display/ECFLOW/Understanding+Includes#head-h"><em>head.h</em></a>.</p>
<div class="line-block">
<div class="line">Note that the file name is given relatively to the file <tt class="file docutils literal"><span class="pre">t1.ecf</span></tt>,</div>
<div class="line">i.e. in the directory above the one containing <tt class="file docutils literal"><span class="pre">t1.ecf</span></tt></div>
</div>
</li>
<li><p class="first">%ECF_HOME% will be substituted by the value of the variable ECF_HOME</p>
</li>
<li><p class="first">%include <em>&#8221;../tail.h&#8221;</em> will be substituted by the content of the file <a class="reference internal" href="/wiki/display/ECFLOW/Understanding+Includes#tail-h"><em>tail.h</em></a></p>
</li>
</ul>
<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>

Job creation

Before submitting the task, the server will transform the ecf script to a job file

This process is known as job creation.

This involves locating the ecf script on disk, and then pre-processing the

directives. This process includes performing variable substitution.

This will create a file with a ‘.job’ extension.

This is the script that ecflow_server will submit to your system.

In our case:

%include ”../head.h” will be substituted by the content of the file head.h.
Note that the file name is given relatively to the file t1.ecf,
i.e. in the directory above the one containing t1.ecf
%ECF_HOME% will be substituted by the value of the variable ECF_HOME
%include ”../tail.h” will be substituted by the content of the file tail.h

What to do

Create the ecf script t1.ecf in $HOME/course/test directory

Horizontal Navigation Bar

Button Group

Button Hyperlink

title	Previous
type	standard
url	https://confluence.ecmwf.int/display/ECFLOW/Understanding+Includes

Button Hyperlink

title	Up
type	standard
url	https://confluence.ecmwf.int/display/ECFLOW/Tutorial

Button Hyperlink

title	Next
type	standard
url	https://confluence.ecmwf.int/display/ECFLOW/Checking+job+creation

Content

Space Tools

Versions Compared

Old Version 15

New Version Current

Key

Job creation

What to do