<div class="section" id="getting-started"> <span id="index-0"></span><span id="id1"></span> <p>Create a directory called course in your home directory (mkdir course)</p> <div class="line-block"> <div class="line">In order to use ecFlow we first need to start 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> <div class="line-block"> <div class="line">Depending on your machine choose between the two methods below to start</div> <div class="line">the server.</div> </div> <div class="section" id="shared-machine"> <h2>Shared Machine<a class="headerlink" href="#shared-machine" title="Permalink to this headline">¶</a></h2> <div class="line-block"> <div class="line">Open a new window, change the current directory to course (cd course) and start an <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 you are using a shared machine then type</div> </div> <div class="highlight-python"><pre>> ecf_start.sh</pre> </div> <div class="line-block"> <div class="line">This will start an <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecflow-server"><em class="xref std std-term">ecflow_server</em></a> running on your system with a port number unique to your user ID.</div> <div class="line">ECF log files and check point files are created in the current directory by default.</div> </div> <div class="line-block"> <div class="line">Please keep a note of the <strong>Host</strong> and <strong>Port</strong> given from your ecf_start.sh output for later.</div> <div class="line">The host and port number uniquely identify your ECF server.</div> <div class="line">When you want to access this server with <a class="reference internal" href="/wiki/display/ECFLOW/ecFlow+Python+Api#python-api"><em>ecFlow Python Api</em></a> or <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecflowview"><em class="xref std std-term">ecflowview</em></a> you need to know these numbers.</div> <div class="line">By setting the value of the environment variables ECF_NODE and ECF_PORT you identify the server you wish to access.</div> <div class="line">Multiple <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecflow-server"><em class="xref std std-term">ecflow_server</em></a>‘s can run on the same system.</div> </div> </div> <div class="section" id="local-machine"> <h2>Local Machine<a class="headerlink" href="#local-machine" title="Permalink to this headline">¶</a></h2> <p>Alternatively if you are running on your own local machine type</p> <div class="highlight-python"><pre>> ecflow_server</pre> </div> <p>at the unix prompt.</p> <div class="line-block"> <div class="line">This will start an <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-ecflow-server"><em class="xref std std-term">ecflow_server</em></a> running on your system with a default host name of “localhost” and</div> <div class="line">port number of 3141. If another program on your machine is using this port number, then you will get</div> <div class="line">an “Address in use” error.</div> <div class="line">To start the server on a specific port number you can use:</div> </div> <div class="highlight-python"><pre>> ecflow_server --port=3500</pre> </div> <p>or:</p> <div class="highlight-python"><pre>> export ECF_PORT=3500; ecflow_server</pre> </div> <div class="line-block"> <div class="line">ECF log files and <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-check-point"><em class="xref std std-term">check point</em></a> files are created in the current directory by default, and have</div> <div class="line">a prefix <machine_name>.<port_number>. As this allows multiple servers to run on the same machine.</div> </div> <div class="line-block"> <div class="line">If you had previously run the same ECF server in the past it will also attempt to recover the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-suite-definition"><em class="xref std std-term">suite definition</em></a></div> <div class="line">from the <a class="reference internal" href="/wiki/display/ECFLOW/Glossary#term-check-point"><em class="xref std std-term">check point</em></a> file.</div> </div> <p>What to do:</p> <ul class="simple"> <li>Start the server</li> </ul> </div> </div> |