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