Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0
HTML
<style type="text/css
<div class="section" id="repeat">
.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="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 task or family 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">There are three kinds of data you can loop on:</div>
</div>
<blockquote>
<div><ul class="simple">
<li>strings</li>
<li>integers</li>
<li>dates</li>
</ul>
</div></blockquote>
<div class="line-block">
<div class="line">Integers and dates are specified as a range, with an optional increment (the default is one).</div>
<div class="line">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</div>
</div>
<div class="highlight-python"><pre># Definition of the suite test.
suite test
 edit ECF_INCLUDE "$HOME/course"
 edit ECF_HOME    "$HOME/course"
 family f1
     edit SLEEP 20
     task t1
         meter progress 1 100 90
     task t2
         trigger t1 eq complete
         event a
         event b
     task t3
         trigger t2:a
     task t4
         trigger t2 eq complete
         complete t2:b
     task t5
         trigger t1:progress ge 30
     task t6
         trigger t1:progress ge 60
     task t7
         trigger t1:progress ge 90
 endfamily
 family f2
     edit SLEEP 20
     task t1
         time 00:30 23:30 00:30
     task t2
         day  sunday
     task t3
         date 01.*.*
         time 12:00
     task t4
         time +00:02
     task t5
         time 00:02
 endfamily
 family f3
     task t1
         label info ""
 endfamily
 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>
<p>In python this would be:</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="k">def</span> <span class="nf">list_to_str_vec</span><span class="p">(</span> <span class="n">theList</span> <span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Converts a python list to a C++ StrVec&quot;&quot;&quot;</span>
    <span class="n">strvec</span> <span class="o">=</span> <span class="n">ecflow</span><span class="o">.</span><span class="n">StrVec</span><span class="p">()</span>
    <span class="k">for</span> <span class="n">theStr</span> <span class="ow">in</span> <span class="n">theList</span><span class="p">:</span>
        <span class="n">ecflow</span><span class="o">.</span><span class="n">StrVec</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">strvec</span><span class="p">,</span><span class="n">theStr</span><span class="p">)</span>
    <span class="k">return</span> <span class="n">strvec</span><span class="p">;</span> 
<span id="index-0"></span><span id="id1"></span>
<div class="line-block">
<div class="line">It is sometimes useful to repeat the same task or family 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">There are three kinds of data you can loop on:</div>
</div>
<blockquote>
<div><ul class="simple">
<li>strings</li>
<li>integers</li>
<li>dates</li>
</ul>
</div></blockquote>
<div class="line-block">
<div class="line">Integers and dates are specified as a range, with an optional increment (the default is one).</div>
<div class="line">The name of the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-repeat"><em class="xref std std-term">repeat</em></a> defines an ECF <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-variable"><em class="xref std std-term">variable</em></a>.</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 can write a <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecf-script"><em class="xref std std-term">ecf script</em></a> <strong>/test/f4/f5/t1.ecf</strong> 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><spanspan> <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="n">list_to_str_vec</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><spanspan> <span class="mi">1</span><span class="p">,</span><spanspan> <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><spanspan> <span class="mi">20101230</span><span class="p">,</span><spanspan> <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><spanspan> <span class="s">&quot;&quot;</span><span class="p">)</span>
    <span class="k">return</span> <span class="n">f4</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  
<span class="pk">(</span><span>print</span> <span class="s">&quot;test.defCreating suite definition&quot;</span><span class="p">)</span>span>   
<span class="n">suite<>defs</span> <span class="o">=</span> <span class="n">defs<>ecflow</span><span class="o">.</span><span class="n">add_suite<>Defs</span><span class="p">()</span><spanspan>
<span class="s">&quot;test&quot;</span><spann">suite</span> <span class="po">)=</span>
 <span class="n">suite<>defs</span><span class="o">.</span><span class="n">add_variable<suite</span><span class="p">(</span><span class="s">&quot;ECF_INCLUDEtest&quot;</span><span class="p">,)</span><spanspan>
<span class="n">os<>suite</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>add_variable</span><span class="op">+(</span> <spanspan><span class="s">&quot;/courseECF_INCLUDE&quot;</span><span class="p">),</span>
 <span class="n">suite<>os</span><span class="o">.</span><span class="n">add_variable<>getenv</span><span class="p">(</span><span class="s">&quot;ECF_HOME   HOME&quot;</span><span class="p">)</span> <span class="o">+</span> <span class="s">&quot;/course&quot;</span><span class="p">,)</span><spanspan>
<span class="n">os<>suite</span><span class="o">.</span><span class="n">getenv<>add_variable</span><span class="p">(</span><span class="s">&quot;ECF_HOME&quot;</span><span class="p">),</span>    <span class="on">+</span> <span>os</span><span class="so">&quot;/course&quot;.</span><span class="pn">)</span>

<span>getenv</span><span class="np">suite<>(</span><span class="o">.s">&quot;HOME&quot;</span><span class="n">add_family</span><spanp">)</span> <span class="po">(+</span> <span class="n">create_family_f4<s">&quot;/course&quot;</span><span class="p">()</span> <span

<span class="n">suite</span><span class="po">).</span>
</pre></div>
</div>
<divspan><span class="line-block">
<divn">add_family</span><span class="line">The name of the <a p">(</span> <span class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-repeat"><emn">create_family_f4</span><span class="xref std std-term">repeat</em></a> defines an ECF <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-variable"><em class="xref std std-term">variable</em></a>.</div>
<div class="line">We can write a <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecf-script"><em class="xref std std-term">ecf script</em></a> <strong>/test/f4/f5/t1.ecf</strong> to use these variables</div>
</div>
<div class="highlight-python"><pre>%include &lt;head.h&gt;
ecf_client --label=info "My name is %NAME%" "My value is %VALUE%" "My date is %DATE%"
sleep %SLEEP%
%include &lt;tail.h&gt;</pre>
</div>
<p>What to do:<p">()</span> <span class="p">)</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>Load and begin the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-suite"><em class="xref std std-term">suite</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<>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>