View Source

<div class="section" id="repeat">
<span id="index-0"></span><span id="id1"></span>
<div class="line-block">
<div class="line">It is sometimes useful to repeat the same <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-task"><em class="xref std std-term">task</em></a> or <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-family"><em class="xref std std-term">family</em></a> several times,</div>
<div class="line">looping on a specific value. You can do that by defining a <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-repeat"><em class="xref std std-term">repeat</em></a> attribute.</div>
<div class="line">You can iterate over sequences of:</div>
</div>
<ul class="simple">
<li>strings</li>
<li>integers</li>
<li>dates</li>
</ul>
<div class="line-block">
<div class="line">A sequence of integers or dates is created by specifying the</div>
<div class="line">first and last element, with an optional increment (the default is one).</div>
<div class="line">An ecFlow variable, whose name corresponds to the name of the repeat,</div>
<div class="line">will be generated. This can be used in scripts or <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-trigger"><em class="xref std std-term">trigger</em></a> expressions.</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">We will add a new <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-task"><em class="xref std std-term">task</em></a> /test/f4/f5/t1.</div>
<div class="line">Create new <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecf-script"><em class="xref std std-term">ecf script</em></a> file <tt class="file docutils literal"><span class="pre">$HOME/course/test/f4/f5/t1.ecf</span></tt> to use these variables.</div>
</div>
<div class="highlight-python"><pre>%include &lt;head.h&gt;
ecflow_client --label=info "My name is %NAME%" "My value is %VALUE%" "My date is %DATE%"
sleep %SLEEP%
%include &lt;tail.h&gt;</pre>
</div>
</div>
<div class="section" id="text">
<h2>Text<a class="headerlink" href="#text" title="Permalink to this headline">¶</a></h2>
<p>Let us modify the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-suite-definition"><em class="xref std std-term">suite definition</em></a> file again</p>
<div class="highlight-python"><pre># Definition of the suite test.
suite test
 edit ECF_INCLUDE "$HOME/course"
 edit ECF_HOME    "$HOME/course"

 family f4
     edit SLEEP 2
     repeat string NAME a b c d e f
     family f5
         repeat integer VALUE 1 10
         task t1
             repeat date DATE 19991230 20000105
             label info ""
     endfamily
 endfamily
endsuite</pre>
</div>
</div>
<div class="section" id="python">
<h2>Python<a class="headerlink" href="#python" title="Permalink to this headline">¶</a></h2>
<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_f4</span><span class="p">():</span>
    <span class="n">f4</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;f4&quot;</span><span class="p">)</span>
    <span class="n">f4</span><span class="o">.</span><span class="n">add_variable</span><span class="p">(</span><span class="s">&quot;SLEEP&quot;</span><span class="p">,</span> <span class="mi">2</span><span class="p">)</span>
    <span class="n">f4</span><span class="o">.</span><span class="n">add_repeat</span><span class="p">(</span> <span class="n">ecflow</span><span class="o">.</span><span class="n">RepeatString</span><span class="p">(</span><span class="s">&quot;NAME&quot;</span><span class="p">,</span> <span class="p">[</span><span class="s">&quot;a&quot;</span><span class="p">,</span> <span class="s">&quot;b&quot;</span><span class="p">,</span> <span class="s">&quot;c&quot;</span><span class="p">,</span> <span class="s">&quot;d&quot;</span><span class="p">,</span> <span class="s">&quot;e&quot;</span><span class="p">,</span> <span class="s">&quot;f&quot;</span> <span class="p">]</span> <span class="p">)</span> <span class="p">)</span>
   
    <span class="n">f5</span> <span class="o">=</span> <span class="n">f4</span><span class="o">.</span><span class="n">add_family</span><span class="p">(</span><span class="s">&quot;f5&quot;</span><span class="p">)</span>
    <span class="n">f5</span><span class="o">.</span><span class="n">add_repeat</span><span class="p">(</span> <span class="n">ecflow</span><span class="o">.</span><span class="n">RepeatInteger</span><span class="p">(</span><span class="s">&quot;VALUE&quot;</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">10</span><span class="p">)</span> <span class="p">)</span>
   
    <span class="n">t1</span> <span class="o">=</span> <span class="n">f5</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">t1</span><span class="o">.</span><span class="n">add_repeat</span><span class="p">(</span> <span class="n">ecflow</span><span class="o">.</span><span class="n">RepeatDate</span><span class="p">(</span><span class="s">&quot;DATE&quot;</span><span class="p">,</span> <span class="mi">20101230</span><span class="p">,</span> <span class="mi">20110105</span><span class="p">)</span> <span class="p">)</span>
    <span class="n">t1</span><span class="o">.</span><span class="n">add_label</span><span class="p">(</span><span class="s">&quot;info&quot;</span><span class="p">,</span> <span class="s">&quot;&quot;</span><span class="p">)</span>
    <span class="k">return</span> <span class="n">f4</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_f4</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><strong>What to do:</strong></p>
<ol class="arabic simple">
<li>Type in the changes</li>
<li>Replace 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>How many times will <strong>/test/f4/f5/t1</strong> run?</li>
<li>In <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecflowview"><em class="xref std std-term">ecflowview</em></a>, try to modify the values of a <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-repeat"><em class="xref std std-term">repeat</em></a></li>
</ol>
</div>
</div>