Page History

<div class="section" id="families">
<span id="index-0"></span><span id="id1"></span>
<div class="line-block">
<div class="line">Tasks can be logically grouped into <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-family"><em class="xref std std-term">family</em></a>&#8216;s.</div>
<div class="line">You can picture a suite as a hierarchical structure very similar to a unix</div>
<div class="line">file system, where the families are the directories and the tasks are the files.</div>
<div class="line">The suite is a family with some extra attributes (See <a class="reference internal" href="/wiki/display/ECFLOW/Dates+and+Clocks#dates-and-clocks"><em>Dates and Clocks</em></a>).</div>
<div class="line">Like directories, families can themselves contain other families.</div>
<div class="line">And like directories, different families can contain tasks with similar names</div>
</div>
<div class="line-block">
<div class="line">Unless you tell ecFlow where to find specific files, the default behaviour</div>
<div class="line">is to expect the file structure to reflect the structure of the suite.</div>
</div>
<div class="section" id="ecf-script">
<h2>Ecf Script<a class="headerlink" href="#ecf-script" title="Permalink to this headline">¶</a></h2>
<div class="line-block">
<div class="line">In suite definition below we will create a family <strong>f1</strong> with two tasks <strong>t1</strong> and <strong>t2</strong>.</div>
<div class="line">In this case you will have to create a directory <tt class="file docutils literal"><span class="pre">$HOME/course/test/f1</span></tt>,</div>
<div class="line">and move <tt class="file docutils literal"><span class="pre">t1.ecf</span></tt> and <tt class="file docutils literal"><span class="pre">t2.ecf</span></tt> into it.</div>
<div class="line">Conversely, the ecFlow jobs and the outputs will be created in this directory.</div>
</div>
<div class="line-block">
<div class="line">Because we have moved the scripts to another directory, ecFlow will not find</div>
<div class="line">the two included files <a class="reference internal" href="/wiki/display/ECFLOW/Understanding+Includes#head-h"><em>head.h</em></a> and <a class="reference internal" href="/wiki/display/ECFLOW/Understanding+Includes#tail-h"><em>tail.h</em></a> one directory up from</div>
<div class="line">the scripts.</div>
</div>
<div class="line-block">
<div class="line">We could modify the scripts to search the include file two directories up,</div>
<div class="line">but this would be very cumbersome.</div>
<div class="line">The solution is to define a special ecFlow <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-variable"><em class="xref std std-term">variable</em></a> called <strong>ECF_INCLUDE</strong></div>
<div class="line">that  points to the directory containing the include files. See <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-pre-processing"><em class="xref std std-term">pre-processing</em></a></div>
</div>
<div class="line-block">
<div class="line">Whenever angled brackets are used, ecFlow first looks to see if ECF_INCLUDE</div>
<div class="line">variable is specified. If the variable exists, then it checks to see if file</div>
<div class="line">%ECF_INCLUDE%/head.h exists, otherwise it will then look for %ECF_HOME%/head.h</div>
<div class="line">This has the added advantage that specific includes files can be placed under</div>
<div class="line">ECF_INCLUDE, and includes file common to <strong>many</strong> tasks can placed in</div>
<div class="line">ECF_HOME. For more details see <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-directives"><em class="xref std std-term">directives</em></a>.</div>
</div>
<div class="line-block">
<div class="line">We need to do the following changes to the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecf-script"><em class="xref std std-term">ecf script</em></a>&#8216;s.</div>
</div>
<p>from:</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>
<p>to:</p>
<div class="highlight-python"><pre>%include &lt;head.h&gt;
echo "I am part of a suite that lives in %ECF_HOME%"
%include &lt;tail.h&gt;</pre>
</div>
<div class="line-block">
<div class="line"><a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-suite"><em class="xref std std-term">suite</em></a>&#8216;s, <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-family"><em class="xref std std-term">family</em></a>&#8216;s and <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-task"><em class="xref std std-term">task</em></a>&#8216;s are called <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-node"><em class="xref std std-term">node</em></a>&#8216;s.</div>
<div class="line">Because of this analogy with the unix file system, nodes can be addressed</div>
<div class="line">using full names: <strong>/test/f1/t1</strong> refers to the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-task"><em class="xref std std-term">task</em></a> <strong>t1</strong>, and <strong>/test/f1</strong> refers to the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-family"><em class="xref std std-term">family</em></a> <strong>f1</strong>.</div>
<div class="line">In some contexts, ecFlow will accept relative names, such as <strong>../t1</strong>.</div>
</div>
</div>
<div class="section" id="text">
<h2>Text<a class="headerlink" href="#text" title="Permalink to this headline">¶</a></h2>
<div class="highlight-python"><pre># Definition of the suite test.
suite test
   edit ECF_INCLUDE "$HOME/course"  # replace '$HOME' with the path to your home directory
   edit ECF_HOME    "$HOME/course"
   family f1
      task t1
      task t2
   endfamily
endsuite</pre>
</div>
</div>
<div class="section" id="python">
<h2>Python<a class="headerlink" href="#python" title="Permalink to this headline">¶</a></h2>
<p>If you are using the <a class="reference internal" href="/wiki/display/ECFLOW/ecFlow+Python+Api#suite-definition-python-api"><em>Suite Definition API</em></a>:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="c">#!/usr/bin/env python2.7</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">ecflow</span> 
   
<span class="k">def</span> <span class="nf">create_family_f1</span><span class="p">():</span>
    <span class="n">f1</span> <span class="o">=</span> <span class="n">ecflow</span><span class="o">.</span><span class="n">Family</span><span class="p">(</span><span class="s">&quot;f1&quot;</span><span class="p">)</span>
    <span class="n">f1</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>
    <span class="n">f1</span><span class="o">.</span><span class="n">add_task</span><span class="p">(</span><span class="s">&quot;t2&quot;</span><span class="p">)</span>
    <span class="k">return</span> <span class="n">f1</span>
      
<span class="k">print</span> <span class="s">&quot;Creating suite definition&quot;</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="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_INCLUDE&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_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_family</span><span class="p">(</span> <span class="n">create_family_f1</span><span class="p">()</span> <span class="p">)</span>
<span class="k">print</span> <span class="n">defs</span>

<span class="k">print</span> <span class="s">&quot;Checking job creation: .ecf -&gt; .job0&quot;</span>   
<span class="k">print</span> <span class="n">defs</span><span class="o">.</span><span class="n">check_job_creation</span><span class="p">()</span>

<span class="k">print</span> <span class="s">&quot;Saving definition to file &#39;test.def&#39;&quot;</span>
<span class="n">defs</span><span class="o">.</span><span class="n">save_as_defs</span><span class="p">(</span><span class="s">&quot;test.def&quot;</span><span class="p">)</span>
</pre></div>
</div>
<p>The hierarchy is shown as a tree in <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecflowview"><em class="xref std std-term">ecflowview</em></a>.</p>
<p><strong>What to do:</strong></p>
<ol class="arabic simple">
<li>Update the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-suite-definition"><em class="xref std std-term">suite definition</em></a></li>
<li>Create the directories needed, move the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecf-script"><em class="xref std std-term">ecf script</em></a>&#8216;s</li>
<li>Edit the script to include <a class="reference internal" href="/wiki/display/ECFLOW/Understanding+Includes#head-h"><em>head.h</em></a> and <a class="reference internal" href="/wiki/display/ECFLOW/Understanding+Includes#tail-h"><em>tail.h</em></a> from the ECF_INCLUDE directory.</li>
<li>Replace the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-suite"><em class="xref std std-term">suite</em></a></li>
<li>View the suite in <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecflowview"><em class="xref std std-term">ecflowview</em></a>, notice the tree structure.
You may have to unfold <strong>test</strong> and <strong>f1</strong> to see the tasks, using the middle mouse button.</li>
</ol>
</div>
</div>