Page History

<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-ecflow-server"><em class="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 <tt class="file docutils literal"><span class="pre">test.def</span></tt> 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-ecflow-server"><em 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="text">
<span id="loading-via-cli"></span><h2>Text<a class="headerlink" href="#text" 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; ecflow_client --load=test.def</pre>
</div>
<div class="line-block">
<div class="line">This will check and load the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-suite-definition"><em class="xref std std-term">suite definition</em></a> into the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecflow-server"><em class="xref std std-term">ecflow_server</em></a>.</div>
<div class="line">If the check fails, the suite is not loaded.</div>
</div>
<p>You will have already seen <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecflow-client"><em class="xref std std-term">ecflow_client</em></a> being used in <a class="reference internal" href="/wiki/display/ECFLOW/Understanding+Includes#head-h"><em>head.h</em></a> and <a class="reference internal" href="/wiki/display/ECFLOW/Understanding+Includes#tail-h"><em>tail.h</em></a> include files.</p>
</div>
<div class="section" id="python">
<h2>Python<a class="headerlink" href="#python" title="Permalink to this headline">¶</a></h2>
<div class="line-block">
<div class="line">We can ask the python script to write out the defs as &#8216;.def&#8217; definition file</div>
<div class="line">This can also 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.7</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">ecflow</span> 
   
<span class="k">print</span> <span class="s">&quot;Creating suite definition&quot;</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="k">print</span> <span class="n">defs</span>

<span class="k">print</span> <span class="s">&quot;Checking job creation: .ecf -&gt; .job0&quot;</span>   
<span class="k">print</span> <span class="n">defs</span><span class="o">.</span><span class="n">check_job_creation</span><span class="p">()</span>

<span class="k">print</span> <span class="s">&quot;Saving definition to file &#39;test.def&#39;&quot;</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"># To restore the definition from file &#39;test.def&#39; we can use: </span>
<span class="c"># restored_defs = ecflow.Defs(&quot;test.def&quot;)</span>
</pre></div>
</div>
<p>If you called &#8220;defs.save_as_defs()&#8221; the file <tt class="file docutils literal"><span class="pre">test.def</span></tt> will be written.</p>
<p>This can be loaded in the server as described earlier. (See <a class="reference internal" href="#loading-via-cli"><em>Text</em></a>)</p>
<div class="line-block">
<div class="line">Since the <a class="reference internal" href="/wiki/display/ECFLOW/ecFlow+Python+Api#suite-definition-python-api"><em>suite definition python API</em></a> allows the definition to be built in memory,</div>
<div class="line">it can be directly loaded into the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecflow-server"><em class="xref std std-term">ecflow_server</em></a>.</div>
<div class="line">This can be done by using <tt class="xref py py-class docutils literal"><span class="pre">ecflow.Client</span></tt> python class.</div>
</div>
<div class="highlight-python"><div class="highlight"><pre><span class="k">try</span><span class="p">:</span>
   <span class="k">print</span> <span class="s">&quot;Load the in memory definition(defs) into the server&quot;</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">load</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">However it is <strong>recommended</strong> that the building of the suite definition is separated</div>
<div class="line">from loading it into the server. The loading should be placed into a file. <tt class="file docutils literal"><span class="pre">client.py</span></tt>.</div>
</div>
<div class="highlight-python"><div class="highlight"><pre><span class="c">#!/usr/bin/env python2.7</span>
<span class="kn">import</span> <span class="nn">ecflow</span> 
   
<span class="k">try</span><span class="p">:</span>
    <span class="k">print</span> <span class="s">&quot;Loading definition in &#39;test.def&#39; into the server&quot;</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">load</span><span class="p">(</span><span class="s">&quot;test.def&quot;</span><span class="p">)</span>      <span class="c"># read definition from disk and load 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> in the server.</p>
<p>Have a look in the window running the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecflow-server"><em class="xref std std-term">ecflow_server</em></a>, and look at the log file</p>
<p><strong>What to do:</strong></p>
<ol class="arabic simple">
<li>Load the definition file. Choose between loading as a text file, or using python api.</li>
<li>If using python examine <tt class="file docutils literal"><span class="pre">test.def</span></tt> and create the file <tt class="file docutils literal"><span class="pre">client.py</span></tt>.</li>
<li>Check the log file</li>
</ol>
</div>
</div>