<div id="add-a-meter"> <span id="add-meter"></span><span id="index-0"></span> <div > <div >A <a href="/wiki/display/ECFLOW/Glossary#term-meter"><em >meter</em></a> is very similar to an <a href="/wiki/display/ECFLOW/Glossary#term-event"><em >event</em></a>.</div> <div >Instead of being a boolean value (on/off), it can take a range of integer values.</div> <div >Other tasks are then triggered when the <a href="/wiki/display/ECFLOW/Glossary#term-meter"><em >meter</em></a> reaches a certain value.</div> <div >Like events, <a href="/wiki/display/ECFLOW/Glossary#term-meter"><em >meter</em></a>‘s have names and a <a href="/wiki/display/ECFLOW/Glossary#term-task"><em >task</em></a> can have several of them.</div> </div> <div ><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 ><div ><pre><span >#!/usr/bin/env python2.5</span> <span >import</span> <span >os</span> <span >import</span> <span >ecflow</span> <span >def</span> <span >create_family_f1</span><span >():</span> <span >f1</span> <span >=</span> <span >ecflow</span><span >.</span><span >Family</span><span >(</span><span >"f1"</span><span >)</span> <span >f1</span><span >.</span><span >add_variable</span><span >(</span><span >"SLEEP"</span><span >,</span><span >20</span><span >)</span> <span >t1</span> <span >=</span> <span >f1</span><span >.</span><span >add_task</span><span >(</span><span >"t1"</span><span >)</span> <span >t1</span><span >.</span><span >add_meter</span><span >(</span><span >"progress"</span><span >,</span><span >1</span><span >,</span><span >100</span><span >,</span><span >90</span><span >)</span> <span >t2</span> <span >=</span> <span >f1</span><span >.</span><span >add_task</span><span >(</span><span >"t2"</span><span >)</span> <span >t2</span><span >.</span><span >add_trigger</span><span >(</span><span >"t1 eq complete"</span><span >)</span> <span >t2</span><span >.</span><span >add_event</span><span >(</span><span >"a"</span><span >)</span> <span >t2</span><span >.</span><span >add_event</span><span >(</span><span >"b"</span><span >)</span> <span >t3</span> <span >=</span> <span >f1</span><span >.</span><span >add_task</span><span >(</span><span >"t3"</span><span >)</span> <span >t3</span><span >.</span><span >add_trigger</span><span >(</span><span >"t2:a"</span><span >)</span> <span >t4</span> <span >=</span> <span >f1</span><span >.</span><span >add_task</span><span >(</span><span >"t4"</span><span >)</span> <span >t4</span><span >.</span><span >add_trigger</span><span >(</span><span >"t2 eq complete"</span><span >)</span> <span >t4</span><span >.</span><span >add_complete</span><span >(</span><span >"t2:b"</span><span >)</span> <span >t5</span> <span >=</span> <span >f1</span><span >.</span><span >add_task</span><span >(</span><span >"t5"</span><span >)</span> <span >t5</span><span >.</span><span >add_trigger</span><span >(</span><span >"t1:progress ge 30"</span><span >)</span> <span >t6</span> <span >=</span> <span >f1</span><span >.</span><span >add_task</span><span >(</span><span >"t6"</span><span >)</span> <span >t6</span><span >.</span><span >add_trigger</span><span >(</span><span >"t1:progress ge 60"</span><span >)</span> <span >t7</span> <span >=</span> <span >f1</span><span >.</span><span >add_task</span><span >(</span><span >"t7"</span><span >)</span> <span >t7</span><span >.</span><span >add_trigger</span><span >(</span><span >"t1:progress ge 90"</span><span >)</span> <span >return</span> <span >f1</span> <span >defs</span> <span >=</span> <span >ecflow</span><span >.</span><span >Defs</span><span >()</span> <span >suite</span> <span >=</span> <span >defs</span><span >.</span><span >add_suite</span><span >(</span><span >"test"</span><span >)</span> <span >suite</span><span >.</span><span >add_variable</span><span >(</span><span >"ECF_INCLUDE"</span><span >,</span><span >os</span><span >.</span><span >getenv</span><span >(</span><span >"HOME"</span><span >)</span> <span >+</span> <span >"/course"</span><span >)</span> <span >suite</span><span >.</span><span >add_variable</span><span >(</span><span >"ECF_HOME "</span><span >,</span><span >os</span><span >.</span><span >getenv</span><span >(</span><span >"HOME"</span><span >)</span> <span >+</span> <span >"/course"</span><span >)</span> <span >suite</span><span >.</span><span >add_family</span><span >(</span> <span >create_family_f1</span><span >()</span> <span >)</span> </pre></div> </div> <div > <div >To notify <a href="/wiki/display/ECFLOW/Glossary#term-ecflow-server"><em >ecflow_server</em></a>, the <a href="/wiki/display/ECFLOW/Glossary#term-task"><em >task</em></a> <strong>t1</strong> must call the <a href="/wiki/display/ECFLOW/Glossary#term-ecflow-client"><em >ecflow_client</em></a> –meter.</div> <div >This is also one of the <a href="/wiki/display/ECFLOW/Glossary#term-child-command"><em >child command</em></a>‘s</div> </div> <div ><pre>%include <head.h> 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 ecflow_client --meter progress $n # Notify ecFlow (( n = $n + 1 )) done %include <tail.h></pre> </div> <p>What to do:</p> <ol > <li>Edit the definition file or python to add the modifications.</li> <li>Edit <tt ><span >t1.ecf</span></tt> to call <a href="/wiki/display/ECFLOW/Glossary#term-ecflow-client"><em >ecflow_client</em></a> –meter</li> <li>Copy <tt ><span >t4.ecf</span></tt> to <tt ><span >t5.ecf</span></tt>, <tt ><span >t6.ecf</span></tt> and <tt ><span >t7.ecf</span></tt></li> <li>Load the definition again.</li> <li>Observe the tasks in <a href="/wiki/display/ECFLOW/Glossary#term-ecflowview"><em >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="/wiki/download/attachments/7373012/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="/wiki/download/attachments/7373012/apply.jpg" /></li> </ol> </div> |