<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="add-trigger"> <span id="index-0"></span><span id="id1"></span> <div class="line-block"> <div class="line">In the previous exercise we saw that the two tasks were running simultaneously.</div> <div class="line">We would like now to make sure that <strong>t2</strong> only runs once <strong>t1</strong> is complete.</div> <div class="line">For this we have to define a <a class="reference internal" href="../../../glossary/#term-trigger"><em class="xref std std-term">trigger</em></a></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 task t2 trigger t1 eq complete 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">"f1"</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">"SLEEP"</span><span class="p">,</span><span class="mi">20</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">"t1"</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_task</span><span class="p">(</span><span class="s">"t2"</span><span class="p">)</span> <span class="n">t2</span><span class="o">.</span><span class="n">add_trigger</span><span class="p">(</span><span class="s">"t1 eq complete"</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</span><span class="o">.</span><span class="n">Defs</span><span class="p">(</span><span class="s">"test.def"</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">"test"</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">"ECF_INCLUDE"</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">"HOME"</span><span class="p">)</span> <span class="o">+</span> <span class="s">"/course"</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">"ECF_HOME "</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">"HOME"</span><span class="p">)</span> <span class="o">+</span> <span class="s">"/course"</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> </pre></div> </div> <div class="line-block"> <div class="line">Triggers are used to declare <a class="reference internal" href="../../../glossary/#term-dependencies"><em class="xref std std-term">dependencies</em></a> between two tasks.</div> <div class="line">For instance, the second task might need data created by the first task.</div> </div> <div class="line-block"> <div class="line">When ecFlow tries to start a task, it evaluates the <a class="reference internal" href="../../../glossary/#term-trigger"><em class="xref std std-term">trigger</em></a> expression.</div> <div class="line">If the condition is correct, the task is started, otherwise the task</div> <div class="line">stays <a class="reference internal" href="../../../glossary/#term-queued"><em class="xref std std-term">queued</em></a>.</div> </div> <div class="line-block"> <div class="line">Triggers can be between tasks, or between families, or a mixture.</div> <div class="line">Remember the two rules:</div> </div> <ul class="simple"> <li>A family is <a class="reference internal" href="../../../glossary/#term-complete"><em class="xref std std-term">complete</em></a> when all its tasks are <a class="reference internal" href="../../../glossary/#term-complete"><em class="xref std std-term">complete</em></a>.</li> <li>A task will be started if its triggers and the triggers of all is parent families evaluate to true.</li> </ul> <div class="line-block"> <div class="line">A <a class="reference internal" href="../../../glossary/#term-node"><em class="xref std std-term">node</em></a> can only have one trigger expression, but very complex</div> <div class="line">expressions can be built (and keep in mind that the triggers of the</div> <div class="line">parent nodes are also implicit triggers).</div> </div> <div class="line-block"> <div class="line">Sometimes triggers are also used to prevent too many jobs from running</div> <div class="line">at the same time. In this case the use of a <a class="reference internal" href="../../../glossary/#term-limit"><em class="xref std std-term">limit</em></a> may be a better</div> <div class="line">solution (we will cover limits later on in the <a class="reference internal" href="/wiki/display/ECFLOW/Limits#limits"><em>Limits</em></a> section).</div> </div> <div class="line-block"> <div class="line">Triggers can be very complex, and ecFlow supports all kinds of conditions</div> <div class="line">(not, and, or, ...)</div> </div> <p>What to do:</p> <ol class="arabic simple"> <li>Edit the <a class="reference internal" href="../../../glossary/#term-suite-definition"><em class="xref std std-term">suite definition</em></a> file to add the <a class="reference internal" href="../../../glossary/#term-trigger"><em class="xref std std-term">trigger</em></a>.</li> <li>Play the definition again.</li> <li>Observe the tasks in <a class="reference internal" href="../../../glossary/#term-ecflowview"><em class="xref std std-term">ecFlowview</em></a>.</li> <li>See the triggers by selecting <strong>t1</strong> or <strong>t2</strong> and clicking on the <img alt="triggers" src="/wiki/download/attachments/7373012/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>Search any reference to <strong>t1</strong> by using the <img alt="search" src="/wiki/download/attachments/7373012/search.jpg" /> icon</li> </ol> </div> |