Page History

<div class="section" id="add-a-meter">

<span id="add-meter"></span><span id="index-0"></span>

<div class="line-block">

<div class="line">A <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-meter"><em class="xref std std-term">meter</em></a> is very similar to an <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-event"><em class="xref std std-term">event</em></a>.</div>

<div class="line">Instead of being a boolean value (on/off), it can take a range of integer values.</div>

<div class="line">Other tasks are then triggered when the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-meter"><em class="xref std std-term">meter</em></a> reaches a certain value.</div>

<div class="line">Like events, <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-meter"><em class="xref std std-term">meter</em></a>&#8216;s have names and a <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-task"><em class="xref std std-term">task</em></a> can have several of them.</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

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</span><span class="p">)</span>

    <span class="n">t1</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">&quot;t1&quot;</span><span class="p">)</span>

    <span class="n">t1</span><span class="o">.</span><span class="n">add_meter</span><span class="p">(</span><span class="s">&quot;progress&quot;</span><span class="p">,</span><span class="mi">1</span><span class="p">,</span><span class="mi">100</span><span class="p">,</span><span class="mi">90</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">&quot;t2&quot;</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">&quot;t1 eq complete&quot;</span><span class="p">)</span> 

    <span class="n">t2</span><span class="o">.</span><span class="n">add_event</span><span class="p">(</span><span class="s">&quot;a&quot;</span><span class="p">)</span>

    <span class="n">t2</span><span class="o">.</span><span class="n">add_event</span><span class="p">(</span><span class="s">&quot;b&quot;</span><span class="p">)</span>

    <span class="n">t3</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">&quot;t3&quot;</span><span class="p">)</span>

    <span class="n">t3</span><span class="o">.</span><span class="n">add_trigger</span><span class="p">(</span><span class="s">&quot;t2:a&quot;</span><span class="p">)</span>  

    <span class="n">t4</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">&quot;t4&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&quot;</span><span class="p">)</span>  

    <span class="n">t4</span><span class="o">.</span><span class="n">add_complete</span><span class="p">(</span><span class="s">&quot;t2:b&quot;</span><span class="p">)</span>  

    <span class="n">t5</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">&quot;t5&quot;</span><span class="p">)</span>

    <span class="n">t5</span><span class="o">.</span><span class="n">add_trigger</span><span class="p">(</span><span class="s">&quot;t1:progress ge 30&quot;</span><span class="p">)</span>  

    <span class="n">t6</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">&quot;t6&quot;</span><span class="p">)</span>

    <span class="n">t6</span><span class="o">.</span><span class="n">add_trigger</span><span class="p">(</span><span class="s">&quot;t1:progress ge 60&quot;</span><span class="p">)</span>  

    <span class="n">t7</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">&quot;t7&quot;</span><span class="p">)</span>

    <span class="n">t7</span><span class="o">.</span><span class="n">add_trigger</span><span class="p">(</span><span class="s">&quot;t1:progress ge 90&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</span><span class="o">.</span><span class="n">Defs</span><span class="p">(</span><span class="s">&quot;test.def&quot;</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>

</pre></div>

</div>

<div class="line-block">

<div class="line">To notify <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecf-server"><em class="xref std std-term">ecf_server</em></a>, the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-task"><em class="xref std std-term">task</em></a> <strong>t1</strong> must call the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecf-client"><em class="xref std std-term">ecf_client</em></a> &#8211;meter.</div>

<div class="line">This is also one of the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-child-command"><em class="xref std std-term">child command</em></a>&#8216;s</div>

</div>

<div class="highlight-python"><pre>%include &lt;head.h&gt;

echo "I will now sleep for %SLEEP% seconds"

sleep %SLEEP%

n=1

while [[ $n -le 100 ]]            # Loop 100 times

do

   sleep 1                        # Wait a short time

   ecf_client --meter progress $n # Notify ecFlow

   (( n = $n + 1 ))

done

%include &lt;tail.h&gt;</pre>

</div>

<p>What to do:</p>

<ol class="arabic simple">

<li>Edit the definition file or python to add the modifications.</li>

<li>Edit <tt class="file docutils literal"><span class="pre">t1.ecf</span></tt> to call <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecf-client"><em class="xref std std-term">ecf_client</em></a> &#8211;meter</li>

<li>Copy <tt class="file docutils literal"><span class="pre">t4.ecf</span></tt> to <tt class="file docutils literal"><span class="pre">t5.ecf</span></tt>, <tt class="file docutils literal"><span class="pre">t6.ecf</span></tt> and <tt class="file docutils literal"><span class="pre">t7.ecf</span></tt></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</em></a>.</li>

<li>See the triggers by selecting progress and clicking on the Triggers icon.</li>

<li>Move the mouse pointer over <img alt="progress" src="../../../_images/progress.jpg" /> then with the right mouse button, choose <strong>Edit...</strong></li>

<li>Modify the value of the meter and click on the Apply icon <img alt="apply" src="../../../_images/apply.jpg" /></li>

</ol>

</div>