Page History

<div class="section" id="add-another-task">
<span id="add-task"></span><span id="index-0"></span>
<div class="line-block">
<div class="line">Let&#8217;s add another <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-task"><em class="xref std std-term">task</em></a> named <strong>t2</strong>.</div>
<div class="line">You will need to 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 and add a new script.</div>
<div class="line">First modify the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-suite-definition"><em class="xref std std-term">suite definition</em></a></div>
</div>
<div class="highlight-python"><pre># Definition of the suite test
suite test
   edit ECF_HOME "$HOME/course"
   task t1
   task t2
endsuite</pre>
</div>
<div class="line-block">
<div class="line">As before replace $HOME with the real path to your home directory.</div>
<div class="line">You must also create a file <tt class="file docutils literal"><span class="pre">t2.ecf</span></tt> in <tt class="file docutils literal"><span class="pre">$HOME/course/test</span></tt>.</div>
<div class="line">Simply copy <tt class="file docutils literal"><span class="pre">t1.ecf</span></tt>.</div>
</div>
<p>Then you must load the file again:</p>
<div class="highlight-python"><pre>&gt; ecflow_client --load test.def</pre>
</div>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">This will fail because the suite is already loaded</p>
</div>
<p>Because the suite is already defined, you need to delete and reload it first:</p>
<div class="highlight-python"><pre>&gt; ecflow_client --delete=_all_
&gt; ecflow_client --load=test.def</pre>
</div>
<p>Then restart the suite:</p>
<div class="highlight-python"><pre>&gt; ecflow_client --begin=test</pre>
</div>
<p>If you are using the <a class="reference internal" href="/wiki/display/ECFLOW/ecFlow+Python+Api#python-api"><em>ecFlow Python Api</em></a>:</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="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="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_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_task</span><span class="p">(</span><span class="s">&quot;t1&quot;</span><span class="p">)</span>
<span class="n">suite</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="c"># delete the definition in the server, load a new definition</span>
<span class="n">ci</span> <span class="o">=</span> <span class="n">ecflow</span><span class="o">.</span><span class="n">Client</span><span class="p">();</span>
<span class="n">ci</span><span class="o">.</span><span class="n">set_host_port</span><span class="p">(</span><span class="s">&quot;localhost&quot;</span><span class="p">,</span><span class="s">&quot;3141&quot;</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
    <span class="n">ci</span><span class="o">.</span><span class="n">delete_all</span><span class="p">()</span>           <span class="c"># clear out the server</span>
    <span class="n">ci</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">defs</span><span class="p">)</span>             <span class="c"># load the definition into the server</span>
    <span class="n">ci</span><span class="o">.</span><span class="n">begin_suite</span><span class="p">(</span><span class="s">&quot;test&quot;</span><span class="p">)</span>     
<span class="k">except</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">e</span><span class="p">:</span>
    <span class="k">print</span> <span class="s">&quot;failed: &quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">)</span>
    
</pre></div>
</div>
<div class="line-block">
<div class="line">Rather than deleting, loading and beginning the suite every time you can replace</div>
<div class="line">all or part of the suite for example to replace whole suite.</div>
</div>
<div class="highlight-python"><pre>&gt; ecflow_client --replace /test test.def</pre>
</div>
<p>or to replace part of the suite:</p>
<div class="highlight-python"><pre>&gt; ecflow_client --replace /test/t2 test.def</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="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="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_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_task</span><span class="p">(</span><span class="s">&quot;t1&quot;</span><span class="p">)</span>
<span class="n">suite</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="c"># replace suite /test in the server, with the definition provided in defs</span>
<span class="n">ci</span> <span class="o">=</span> <span class="n">ecflow</span><span class="o">.</span><span class="n">Client</span><span class="p">();</span>
<span class="k">try</span><span class="p">:</span>
    <span class="n">ci</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s">&quot;/test&quot;</span><span class="p">,</span><span class="n">defs</span><span class="p">)</span>     
<span class="k">except</span> <span class="ne">RuntimeError</span><span class="p">,</span> <span class="n">e</span><span class="p">:</span>
    <span class="k">print</span> <span class="s">&quot;failed: &quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">)</span>
    
</pre></div>
</div>
<div class="line-block">
<div class="line">It is good practice to suspend your suite before you reload any part of it.</div>
<div class="line">In <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecflowview"><em class="xref std std-term">ecflowview</em></a> right click on the suite and select &#8220;Suspend&#8221;.</div>
<div class="line">Once you made your change you can right click on the suite and &#8220;Resume&#8221; it.</div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">For <strong>brevity</strong> the following examples, will not show the loading of the suite.</p>
</div>
<p>What to do:</p>
<ol class="arabic simple">
<li>Create the new task</li>
<li>Create <tt class="file docutils literal"><span class="pre">t2.ecf</span></tt> by copying from <tt class="file docutils literal"><span class="pre">t1.ecf</span></tt></li>
<li>Begin the suite</li>
<li>In <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecflowview"><em class="xref std std-term">ecflowview</em></a>, watch the two task running. They should run at the same time</li>
</ol>
</div>