Versions Compared

Old Version 20

changes.mady.by.user Daniel Varela Santoalla

Saved on

compared with

New Version 21

changes.mady.by.user Daniel Varela Santoalla

Saved on

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="add-a-complete">
.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="add-a-complete">
<span id="add-complete"></span><span id="index-0"></span>
<div class="line-block">
<div class="line">Sometimes you do not want to run a<span id="add-complete"></span><span id="index-0"></span>
<div class="line-block">
<div class="line">Sometimes you do not want to run a <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-task"><em class="xref std std-term">task</em></a> when a certain condition is met.</div>
<div class="line">In this case you can use the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-complete-expression"><em class="xref std std-term">complete expression</em></a> keyword.</div>
<div class="line">This has a similar syntax to the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-trigger"><em class="xref std std-term">trigger</em></a> keyword but sets a <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-task"><em class="xref std std-term">task</em></a></div>
<div class="line"><a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-complete"><em class="xref std std-term">complete</em></a> rather than running it.</div>
</div>
<div class="line-block">
<div class="line">Completes are used to declare <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-dependencies"><em class="xref std std-term">dependencies</em></a> between two tasks.</div>
<div class="line">For instance, complete <strong>t2:b</strong> might indicate that a specific</div>
<div class="line"><a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-event"><em class="xref std std-term">event</em></a> has not occurred so we do not need to run task <strong>t4</strong>.</div>
</div>
<div class="line-block">
<div class="line">When <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecflow-server"><em class="xref std std-term">ecflow_server</em></a> tries to start a <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-task"><em class="xref std std-term">task</em></a>, it  evaluates the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-tasktrigger"><em class="xref std std-term">task<>trigger</em></a> when a certain condition is met.</div>
<diva></div>
<div class="line">and <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-complete-expression"><em class="line">Inxref this case you can usestd std-term">complete expression</em></a> s. If the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-complete-triggerexpression"><em class="xref std std-term">complete trigger<expression</em></a> keyword.condition is correct,</div>
<div class="line">This>the hastask awill similarset syntaxitself to the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-triggercomplete"><em class="xref std std-term">trigger</em></a> keyword but sets a <a >complete</em></a>.</div>
</div>
<p><a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-complete-taskexpression"><em class="xref std std-term">task<>complete expression</em></a></div>
<div class="line"><aa> evaluation takes precedence over the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-completetrigger"><em class="xref std std-term">complete<>trigger</em></a> rather than running it.</div>
</div>/a>.</p>
<p>Completes can be between tasks, between families, or both.</p>
<div class="line-block">
<div class="line">It can be used in conjunction with a <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-trigger"><em class="xref std std-term">trigger</em></a>. For example:</div>
</div>/a>. For example:</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
     edit SLEEP 20
     task t1
     task t2
         trigger t1 eq complete
         event a
         event b
     task t3
         trigger t2:a
     task t4
         trigger t2:a
 eq complete
   task t4
     complete t2:b
   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">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_variable</span><span class="p">(</span><span class="s">&quot;SLEEP&quot;</span><span class="p">,</span><span class="mi">20<trigger t2 eq complete
         complete t2:b
   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_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">add_task<>Family</span><span class="p">(</span><span class="s">&quot;t1f1&quot;</span><span class="p">)</span>
    <span class="n">t2<>f1</span>span><span <span class="o">=.</span>span><span <span class="n">f1<>add_variable</span><span class="op">.(</span><span class="n">add_task<s">&quot;SLEEP&quot;</span><span class="p">(,</span><spanspan> <span class="s">&quot;t2&quot;<mi">20</span><span class="p">)</span>  
    <span class="n">t2<>f1</span><span class="o">.</span><span class="n">add_trigger<task</span><span class="p">(</span><span class="s">&quot;t1 eq complete&quot;</span><span class="p">)</span> 
    <span class="n">t2</span> <span class="o">=</span> <span class="n">f1</span><span class="o">.</span><span class="n">add_event<task</span><span class="p">(</span><span class="s">&quot;at2&quot;</span><span class="p">)</span>  
    <span class="n">t2</span><span class="o">.</span><span class="n">add_event<trigger</span><span class="p">(</span><span class="s">&quot;bt1 eq complete&quot;</span><span class="p">)</span> 
    <span class="n">t3</span> <span class="o">=</span> <span class="n">f1<>t2</span><span class="o">.</span><span class="n">add_task<event</span><span class="p">(</span><span class="s">&quot;t3a&quot;</span><span class="p">)</span>
    <span class="n">t3<>t2</span><span class="o">.</span><span class="n">add_trigger<event</span><span class="p">(</span><span class="s">&quot;t2:a&quot;</span><span class="p">)</span>  
    <span class="n">t4</span> <spanb&quot;</span><span class="op">=)</span>
    <span class="n">f1</span><span class="o">.</span><span class="n">add_task</span><span class="p">(</span><span class="s">&quot;t4t3&quot;</span><span class="p">)</span>
    <span class="n">t4</span><span class="o">.</span><span class="n">add_trigger</span><span class="p">(</span><span class="s">&quot;t2 eq complete:a&quot;</span><span class="p">)</span>  
    <span class="n">t4</span> <span class="o">=</span> <span class="n">t4<>f1</span><span class="o">.</span><span class="n">add_complete<task</span><span class="p">(</span><span class="s">&quot;t2:bt4&quot;</span><span class="p">)</span>  
    <span class="k">return</span> <span class="n">f1</span>
      
<span class="n">defs</span> <span class="o">=">)</span>
    <span class="n">ecflow<>t4</span><span class="o">.</span><span class="n">Defs<>add_trigger</span><span class="p">(</span><span class="s">&quot;test.deft2 eq complete&quot;</span><span class="p">)</span>  
<span class="n">suite</span> <span class="o">=</span> <span class="n">defs<>t4</span><span class="o">.</span><span class="n">add_suite<complete</span><span class="p">(</span><span class="s">&quot;testt2:b&quot;</span><span class="p">)</span>  
    <span class="n">suite</span><span class="o">.</span><spank">return</span> <span class="n">add_variable</span><span>f1</span>
      
<span class="pk">(</span><span>print</span> <span class="s">&quot;ECF_INCLUDECreating suite definition&quot;</span><span class="p">,</span><spanspan>   
<span class="n">os<>defs</span><spanspan> <span class="o">.=</span><spanspan> <span class="n">getenv<>ecflow</span><span class="po">(.</span><span class="s">&quot;HOME&quot;<n">Defs</span><span class="p">()</span> 
<span class="on">+<>suite</span> <span class="so">&quot;/course&quot;</span><span class="p">)</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_HOME   test&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;HOMEECF_INCLUDE&quot;</span><span class="p">),</span> <span class="on">+<>os</span>span><span <span class="so">&quot;/course&quot;.</span><span class="p">)</span>

<span class="n">suite<>getenv</span><span class="op">.(</span><span class="n">add_family<s">&quot;HOME&quot;</span><span class="p">()</span> <span class="n">create_family_f1</span><spano">+</span> <span class="ps">()&quot;/course&quot;</span> <spanspan><span class="p">)</span>
</pre></div>
</div>
<div<span class="n">suite</span><span class="o">.</span><span class="line-block">
<divn">add_variable</span><span class="line">Completes are used to declare dependencies between two tasks.</div>
<divp">(</span><span class="line">For instance, complete <strong>t2:b</strong> might indicate that a specific</div>
<divs">&quot;ECF_HOME&quot;</span><span class="line">event has not occurred so we do not need to run task <strong>t4</strong>.</div>
</div>
<div class="line-block">
<divp">,</span>    <span class="n">os</span><span class="line">When <ao">.</span><span class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecf-server"><emn">getenv</span><span class="p">(</span><span class="xref std std-term">ecf_server</em></a> tries to start a <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-task"><em class="xref std std-term">task</em></a>, it  evaluates the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-trigger"><em class="xref std std-term">trigger</em></a></div>
<div class="line">and <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-complete-trigger"><em class="xref std std-term">complete trigger</em></a> expressions. If the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-complete-trigger"><em class="xref std std-term">complete trigger</em></a> condition is correct,</div>
<div class="line">the task will set itself <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-complete"><em class="xref std std-term">complete</em></a>.</div>
</div>
<p><a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-complete-trigger"><em class="xref std std-term">complete trigger</em></a> evaluation takes precedence over the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-trigger"><em class="xref std std-term">trigger</em></a>.</p>
<p>Completes can be between tasks, between families, or both.</p>
<p>What to do:<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="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>Edit the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-suite-definition"><em class="xref std std-term">suite definition</em></a> file or python to add a complete to task <strong>t4</strong></li>
<li>Load the definition again</li>
<li>Observe the tasks in <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecflowview"><em class="xref std std-term">ecFlowview<>ecflowview</em></a></li>
<li>See the triggers by selecting <strong>t4</strong> and clicking on the <img alt="triggers" src="../wiki../download/attachments/7373012../_images/triggers.jpg" /> icon</li>
<li>See the trigger relation by clicking on the arrow</li>
<li>See the triggers in the tree, using the Show menu</li>
<li>Note the icon indicating that the task has not run</li>
<li>You can modify task <strong>t2</strong> to check that task <strong>t4</strong> will run when the event is not set</li>
</ol>
</div>
</div>