| 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-ecf-server"><em class="xref std std-term">ecf_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 “load” 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-ecf-server"><em class="xref std std-term">ecf_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="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>> ecf_client --load=test.def</pre> </div> <p>The executable <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecf-client"><em class="xref std std-term">ecf_client</em></a> provides the shell level interface for communication with the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecf-server"><em class="xref std std-term">ecf_server</em></a>.</p> <p>You will have already seen <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecf-client"><em class="xref std std-term">ecf_client</em></a> being used in <a class="reference internal" href="/wiki/display/ECFLOW/Getting+Started#head-h"><em>head.h</em></a> and <a class="reference internal" href="/wiki/display/ECFLOW/Getting+Started#tail-h"><em>tail.h</em></a> include files.</p> <p>For a full list of commands type:</p> <div class="highlight-python"><pre>> ecf_client --help</pre> </div> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">All the functionality provided by <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecf-client"><em class="xref std std-term">ecf_client</em></a> is also available via the <a class="reference internal" href="/wiki/display/ECFLOW/ecFlow+Python+Api#python-api"><em>ecFlow Python Api</em></a>. Please see <a class="reference internal" href="/wiki/display/ECFLOW/ecFlow+Python+Api#ecflow.Client" title="ecflow.Client"><tt class="xref py py-class docutils literal"><span class="pre">ecflow.Client</span></tt></a></p> </div> </div> <div class="section" id="loading-suite-created-in-python"> <h2>Loading Suite created in python<a class="headerlink" href="#loading-suite-created-in-python" title="Permalink to this headline">¶</a></h2> <p>We can ask the python script to write out the defs as ‘.def’ definition file:</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="s">"test.def"</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">"test"</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">"ECF_HOME"</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">"HOME"</span><span class="p">)</span> <span class="o">+</span> <span class="s">"/course"</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">"t1"</span><span class="p">)</span> <span class="c"># this will generate a file 'test.def'</span> <span class="n">defs</span><span class="o">.</span><span class="n">save_as_defs</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 “defs.save_as_defs()” 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 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 is more efficient if this could be directly loaded into the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecf-server"><em class="xref std std-term">ecf_server</em></a>.</p> <p>This can be done by using <a class="reference internal" href="/wiki/display/ECFLOW/ecFlow+Python+Api#ecflow.Client" title="ecflow.Client"><tt class="xref py py-class docutils literal"><span class="pre">ecflow.Client</span></tt></a> 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 class="n">ci</span><span class="o">.</span><span class="n">set_host_port</span><span class="p">(</span><span class="s">"localhost"</span><span class="p">,</span><span class="s">"3141"</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">ping</span><span class="p">()</span> <span class="c"># Ping the server, to see if its running</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="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">"failed: "</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-ecf-server"><em class="xref std std-term">ecf_server</em></a>, and look at the log file</p> <p>What to do:</p> <ol class="arabic simple"> <li>Load the definition file</li> <li>Check the log file</li> </ol> </div> </div> |
Page History
Overview
Community Forums
Content Tools