Page History
| HTML |
|---|
<style type="text/css <div class="section" id="load-the-file"> .highlight .hll { background-color: #ffffcc } .highlight { background: #eeffcc; } .highlight .c { color: #408090; font-style: italic } /* Comment */ .highlight .err { border: 1px solid #FF0000 } /* Error */ .highlight .k { color: #007020; font-weight: bold } /* Keyword */ .highlight .o { color: #666666 } /* Operator */ .highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */ .highlight .cp { color: #007020 } /* Comment.Preproc */ .highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */ .highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */ .highlight .gd { color: #A00000 } /* Generic.Deleted */ .highlight .ge { font-style: italic } /* Generic.Emph */ .highlight .gr { color: #FF0000 } /* Generic.Error */ .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ .highlight .gi { color: #00A000 } /* Generic.Inserted */ .highlight .go { color: #303030 } /* Generic.Output */ .highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */ .highlight .gs { font-weight: bold } /* Generic.Strong */ .highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ .highlight .gt { color: #0040D0 } /* Generic.Traceback */ .highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */ .highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */ .highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */ .highlight .kp { color: #007020 } /* Keyword.Pseudo */ .highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */ .highlight .kt { color: #902000 } /* Keyword.Type */ .highlight .m { color: #208050 } /* Literal.Number */ .highlight .s { color: #4070a0 } /* Literal.String */ .highlight .na { color: #4070a0 } /* Name.Attribute */ .highlight .nb { color: #007020 } /* Name.Builtin */ .highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */ .highlight .no { color: #60add5 } /* Name.Constant */ .highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */ .highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */ .highlight .ne { color: #007020 } /* Name.Exception */ .highlight .nf { color: #06287e } /* Name.Function */ .highlight .nl { color: #002070; font-weight: bold } /* Name.Label */ .highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */ .highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */ .highlight .nv { color: #bb60d5 } /* Name.Variable */ .highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */ .highlight .w { color: #bbbbbb } /* Text.Whitespace */ .highlight .mf { color: #208050 } /* Literal.Number.Float */ .highlight .mh { color: #208050 } /* Literal.Number.Hex */ .highlight .mi { color: #208050 } /* Literal.Number.Integer */ .highlight .mo { color: #208050 } /* Literal.Number.Oct */ .highlight .sb { color: #4070a0 } /* Literal.String.Backtick */ .highlight .sc { color: #4070a0 } /* Literal.String.Char */ .highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */ .highlight .s2 { color: #4070a0 } /* Literal.String.Double */ .highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */ .highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */ .highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */ .highlight .sx { color: #c65d09 } /* Literal.String.Other */ .highlight .sr { color: #235388 } /* Literal.String.Regex */ .highlight .s1 { color: #4070a0 } /* Literal.String.Single */ .highlight .ss { color: #517918 } /* Literal.String.Symbol */ .highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */ .highlight .vc { color: #bb60d5 } /* Name.Variable.Class */ .highlight .vg { color: #bb60d5 } /* Name.Variable.Global */ .highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */ .highlight .il { color: #208050 } /* Literal.Number.Integer.Long */ </style> <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 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 “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 <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>> 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 ‘.def’ 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">"Creating suite definition"</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">"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="k">print</span> <span class="s">"Checking job creation: .ecf -> .job0"</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">"Saving definition to file 'test.def'"</span> <span class="n">defs</span><span class="o">.</span><span class="n">Defs<>save_as_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<quot;</span><span class="op">.)</span><spanspan> <span class="n">add_suite</span><spanc"># To restore the definition from file 'test.def' we can use: </span> <span class="p">(</span><span class="s">c"># restored_defs = ecflow.Defs("test.def"</span><span class="p">)</span> <span)</span> </pre></div> </div> <p>You can also print the defs. The output will written to standard out:</p> <div class="n">suite</span><spanhighlight-python"><div class="o">.</span><spanhighlight"><pre><span class="nk">add_variable</span><span>print</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<n">defs</span> </pre></div> </div> <p>If you called “defs.save_as_defs()” 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 <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.</div> </div> <div class="highlight-python"><div class="highlight"><pre><span class="k">try</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 <span class="k">print</span> <span class="s">"Load the in memory definition(defs) into the server"</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">"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> <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">ecflow>client.Client<py</span></tt></a> python class:tt>.</div> </p>div> <div class="highlight-python"><div class="highlight"><pre><span class="c">#!/usr/bin/env python2.7</span> <span class="highlight"><pre><spankn">import</span> <span class="nnn">ci<>ecflow</span> <span class="ok">try</span><span class="p">=:</span> <span class="nk">ecflow<>print</span><spanspan> <span class="os">.</span><span class="n">Client</span><span class="p">()"Loading definition in 'test.def' into the server"</span> <span class="n">ci</span><spanspan> <span class="o">.=</span><span class="n">set_host_port</span><span class="p">(</span><span class="s">"localhost"<span> <span class="n">ecflow</span><span class="po">,.</span><span class="s">"3141"<n">Client</span><span class="p">();</span> <span class="kn">try<>ci</span><span class="po">:.</span> <spanspan><span class="n">ci<>load</span><span class="op">.(</span><span class="n">ping<"s">"test.def"</span><span class="p">()</span> <span class="c"># read Pingdefinition thefrom server,disk toand seeload ifinto itsthe running<server</span> <span class="nk">ci<>except</span><span class="o">.</span><spanspan> <span class="nne">load<>RuntimeError</span><span class="p">(,</span><spanspan> <span class="n">defs<>e</span><span class="p">):</span> <span class="c"># load the definition into the server</span> k">print</span> <span class="k">except<s">"Failed: "</span> <span class="ne">RuntimeError</span><span class="po">,+</span> <span class="nnb">e<>str</span><span class="p">:(</span> <span span><span class="kn">print<>e</span>span><span <span class="sp">"failed: ");</span> <span class="o">+</span> <span </pre></div> </div> <p>If everything is OK, you should have defined a <a class="nb">str</span><spanreference internal" href="/wiki/display/ECFLOW/Glossary#term-suite"><em class="p">(</span><spanxref std std-term">suite</em></a> in the server.</p> <p>Have a look in the window running the <a class="n">e</span><spanreference internal" href="/wiki/display/ECFLOW/Glossary#term-ecflow-server"><em 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<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> |