<div id="load-the-file"> <span id="load-file"></span><span id="index-0"></span> <p>The next step is to let <a href="/wiki/display/ECFLOW/Glossary#term-ecflow-server"><em >ecflow_server</em></a> know about your <a href="/wiki/display/ECFLOW/Glossary#term-suite"><em >suite</em></a> or to “load” the <a href="/wiki/display/ECFLOW/Glossary#term-suite-definition"><em >suite definition</em></a> file.</p> <p>This checks the file <em>test.def</em> and describes the <a href="/wiki/display/ECFLOW/Glossary#term-suite"><em >suite</em></a> to the <a href="/wiki/display/ECFLOW/Glossary#term-ecflow-server"><em >ecflow_server</em></a>.</p> <p>This can be done in several ways, depending on how the <a href="/wiki/display/ECFLOW/Glossary#term-suite"><em >suite</em></a> was created.</p> <div > <p >Note</p> <p >Choose between the two methods below, to avoid errors associated with loading <a href="/wiki/display/ECFLOW/Glossary#term-suite-definition"><em >suite definition</em></a> twice.</p> </div> <div 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 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 ><pre>> ecflow_client --load=test.def</pre> </div> <div > <div >This will check and load the <a href="/wiki/display/ECFLOW/Glossary#term-suite-definition"><em >suite definition</em></a> into the <a href="/wiki/display/ECFLOW/Glossary#term-ecflow-server"><em >ecflow_server</em></a>.</div> <div >If the check fails, the suite is not loaded.</div> </div> <p>You will have already seen <a href="/wiki/display/ECFLOW/Glossary#term-ecflow-client"><em >ecflow_client</em></a> being used in <a href="/wiki/display/ECFLOW/Understanding+Includes#head-h"><em>head.h</em></a> and <a href="/wiki/display/ECFLOW/Understanding+Includes#tail-h"><em>tail.h</em></a> include files.</p> </div> <div id="loading-a-suite-created-in-python"> <h2>Loading a Suite created in python<a href="#loading-a-suite-created-in-python" title="Permalink to this headline">¶</a></h2> <div > <div >We can ask the python script to write out the defs as ‘.def’ definition file</div> <div >This could be useful for debugging when you have a complex <a href="/wiki/display/ECFLOW/Glossary#term-suite-definition"><em >suite definition</em></a>:</div> </div> <div ><div ><pre><span >#!/usr/bin/env python2.5</span> <span >import</span> <span >os</span> <span >import</span> <span >ecflow</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_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_task</span><span >(</span><span >"t1"</span><span >)</span> <span ># Save definition to file 'test.def'</span> <span >defs</span><span >.</span><span >save_as_defs</span><span >(</span><span >"test.def"</span><span >)</span> <span ># Restore the definition from file 'test.def' </span> <span >restored_defs</span> <span >=</span> <span >ecflow</span><span >.</span><span >Defs</span><span >(</span><span >"test.def"</span><span >)</span> </pre></div> </div> <p>You can also print the defs. The output will written to standard out:</p> <div ><div ><pre><span >print</span> <span >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 href="#loading-via-cli"><em>Loading a Suite created as a text file</em></a></p> <div > <div ><strong>However</strong> since the <a href="/wiki/display/ECFLOW/ecFlow+Python+Api#python-api"><em>ecFlow Python Api</em></a> allows the definition to be built in memory,</div> <div >it is more efficient if this could be directly loaded into the <a href="/wiki/display/ECFLOW/Glossary#term-ecflow-server"><em >ecflow_server</em></a>.</div> </div> <p>This can be done by using <tt ><span >ecflow.Client</span></tt> python class:</p> <div ><div ><pre><span >ci</span> <span >=</span> <span >ecflow</span><span >.</span><span >Client</span><span >();</span> <span >try</span><span >:</span> <span >ci</span><span >.</span><span >load</span><span >(</span><span >defs</span><span >)</span> <span ># load the definition into the server</span> <span >except</span> <span >RuntimeError</span><span >,</span> <span >e</span><span >:</span> <span >print</span> <span >"failed: "</span> <span >+</span> <span >str</span><span >(</span><span >e</span><span >);</span> </pre></div> </div> <p>If everything is OK, you should have defined a <a href="/wiki/display/ECFLOW/Glossary#term-suite"><em >suite</em></a>.</p> <p>Have a look in the window running the <a href="/wiki/display/ECFLOW/Glossary#term-ecflow-server"><em >ecflow_server</em></a>, and look at the log file</p> </div> <div id="what-to-do"> <h2>What to do<a href="#what-to-do" title="Permalink to this headline">¶</a></h2> <ol > <li>Load the definition file. Choose between loading as a text file, or using python api.</li> <li>Check the log file</li> </ol> </div> </div> |