Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
HTML
<div class="section" id="load-the-file">
<span id="load-file"></span><span id="index-0"></span>
<p>The next step is to let <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecfecflow-server"><em >ecfclass="xref std std-term">ecflow_server</em></a> know about your <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-suite"><em class="xref std std-term">suite</em></a> or to &#8220;load&#8221; the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-suite-definition"><em class="xref std std-term">suite definition</em></a> file.</p>
<p>This checks the file <em>test.def</em> and describes the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-suite"><em class="xref std std-term">suite</em></a> to the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecfecflow-server"><em >ecf class="xref std std-term">ecflow_server</em></a>.</p>
<p>This can be done in several ways, depending on how the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-suite"><em class="xref std std-term">suite</em></a> was created.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Choose between the two methods below, to avoid errors associated with loading <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-suite-definition"><em class="xref std std-term">suite definition</em></a> twice.</p>
</div>
<div class="section" id="loading-a-suite-created-as-a-text-file">
<span id="loading-via-cli"></span><h2>Loading a Suite created as a text file<a class="headerlink" href="#loading-a-suite-created-as-a-text-file" title="Permalink to this headline">¶</a></h2>
<p>From within the course directory do the following from the unix shell:</p>
<div class="highlight-python"><pre>&gt; ecfecflow_client --load=test.def</pre>
</div>
<p>The executable <a  href="/wiki/display/ECFLOW/Glossary#term-ecf-client"><em >ecf_client</em></a> provides the shell level interface for communication with
the <a  <div class="line-block">
<div class="line">This will check and load the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecfsuite-serverdefinition"><em >ecf_server< class="xref std std-term">suite definition</em></a>.</p>
<p>You will have already seen <a   into the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecfecflow-clientserver"><em >ecf_client</em></a> being used in <a  href="/wiki/display/ECFLOW/Getting+Started#head-h"><em>head.h</em></a> and <a  href="/wiki/display/ECFLOW/Getting+Started#tail-h"><em>tail.h<class="xref std std-term">ecflow_server</em></a>
include files.</p>div>
<p>For a full list of commands type:</p>
<div ><pre>&gt; ecf_client --help</pre><div class="line">If the check fails, the suite is not loaded.</div>
</div>
<div<p>You >
<p >Note</p>
<p >All the functionality provided by <a  will have already seen <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecfecflow-client"><em >ecfclass="xref std std-term">ecflow_client</em></a> isbeing alsoused availablein via the <a  <a class="reference internal" href="/wiki/display/ECFLOW/ecFlowUnderstanding+Python+Api#pythonIncludes#head-api"><em>ecFlow Python Api<h"><em>head.h</em></a>. Pleaseand see <a <a class="reference internal" href="/wiki/display/ECFLOW/ecFlow+Python+Api#ecflow.Client" title="ecflow.Client"><tt ><span >ecflow.Client</span></tt></a></Understanding+Includes#tail-h"><em>tail.h</em></a> include files.</p>
</div>
</div>
<div class="section" id="loading-a-suite-created-in-python">
<h2>Loading a Suite created in python<a class="headerlink" href="#loading-a-suite-created-in-python" title="Permalink to this headline">¶</a></h2>
<p>We
<div class="line-block">
<div class="line">We can ask the python script to write out the defs as &#8216;.def&#8217; definition file:</p>
<div ><div ><pre><span  file</div>
<div class="line">This could be useful for debugging when you have a complex <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"><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 >(</span><span >&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_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="c"># thisSave willdefinition generateto a file &#39;test.def&#39;</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>

<span class="c"># Restore the definition from file &#39;test.def&#39;  </span>
<span class="n">restored_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>
</pre></div>
</div>
<p>You can also print the defs. The output will written to standard out:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">print</span> <span class="n">defs</span>
</pre></div>
</div>
<p>If you called &#8220;defs.save_as_defs()&#8221; the file <em>test.def</em> will be written.</p>
<p>This can be loaded in the server as described earlier <a class="reference internal" href="#loading-via-cli"><em>Loading a Suite created as a text file</em></a></p>
<p>However<div class="line-block">
<div class="line"><strong>However</strong> since the <a class="reference internal" href="/wiki/display/ECFLOW/ecFlow+Python+Api#python-api"><em>ecFlow Python Api</em></a> allows the definition to be built in memory,
it</div>
<div class="line">it is more efficient if this could be directly loaded into the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecfecflow-server"><em >ecf class="xref std std-term">ecflow_server</em></a>.</p>div>
</div>
<p>This can be done by using <a<tt  href="/wiki/display/ECFLOW/ecFlow+Python+Api#ecflow.Client" title="ecflow.Client"><tt ><span class="xref py py-class docutils literal"><span class="pre">ecflow.Client</span></tt></a>tt> python class:</p>
<div class="highlight-python"><div class="highlight"><pre><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 >ci</span><span >.</span><span >set_host_port</span><span >(</span><span >&quot;localhost&quot;</span><span >,</span><span >&quot;3141&quot;</span><span >)</span>

<span class="k">try</span><span class="p">:</span>
   <span class="n">ci</span><span class="o">.</span><span >ping</span><span >()</span>                 <span ># Ping the server, to see if its running</span>
   <span >ci</span><span >.</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="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>
<p>If everything is OK, you should have defined a <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-suite"><em class="xref std std-term">suite</em></a>.</p>
<p>Have a look in the window running the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecfecflow-server"><em >ecfclass="xref std std-term">ecflow_server</em></a>, and look at the log file</p>
<p>What to do:</p>
<ol </div>
<div class="section" id="what-to-do">
<h2>What to do<a class="headerlink" href="#what-to-do" title="Permalink to this headline">¶</a></h2>
<ol class="arabic simple">
<li>Load the definition file<file. Choose between loading as a text file, or using python api.</li>
<li>Check the log file</li>
</ol>
</div>
</div>