minor doc text changes

- Clarified that the client can be run on any machine
- Instruction on how to shut down the worker
- Clarified that cpc-worker command fetches cnx bundle from default
  location
Change-Id: Ic43637f55ef4901f2c869458a0eb94e9b639c348

README.txt

@@ -1,3 +1,20 @@
-Copernicus is a system that aims to take the scope of computer simulations from the level of individual simulation runs to one focused on obtaining results by  allowing the user to specify these end results rather than a detailed prescription of how to obtain them. It is then up to the Copernicus run-time system to break these desired end-results up into specific tasks and to run these tasks as efficiently as possible on the available computational resources.
+Copernicus is an open source platform that lets you automate problems that require more computing power than your single workstation provide. Using the platform you can consolidate you’re desktop machines, supercomputing cluster and cloud instances and use them all at once to solve distributed computing problems.
+It was first developed with the support of ERC project 209825 and and is now continued in the Scalalife and Cresta projects.
 
-For usage instructions, see doc/usage/guide.html.
+Head authors & project leaders
+-------------------------------
+Sander Pronk
+Iman Pouya (Royal Institute of Technology, Sweden)
+Peter Kasson (University of Virginia, USA)
+Erik Lindahl (Royal Institute of Technology, Sweden)
+
+
+Other current developers
+-------------------------
+Magnus Lundborg (Royal Institute of Technology, Sweden)
+Björn Wesen (RoyL Institute of Technology,Sweden)
+
+Previous Developers and contributors
+------------------------------------
+Patrik Falkman
+Grant Rotskoff ( University of California, Berkley, US )

doc/_build/html/_sources/getting-started.txt

@@ -137,8 +137,10 @@ This will generate C code from Python files that will then be compiled to shared
 ------------
 Client Setup
 ------------
-To use the client, a server to connect to must first be specified. T
-o specify a server, use the ``add-server`` command:
+The client is a command line tool use to send commands to the server.
+it can be run directly from your laptop. But before sending commands to a server
+it needs to know its address
+This is done with the``add-server`` command:
 
 ``cpcc add-server my.serverhostname.com``
 
@@ -181,9 +183,8 @@ To verify that the worker can connect to a server start it with
 
 ``cpc-worker smp``
 
-this command that there is a connection bundle located in .copernicus
-
-you can also specify which bundle to use
+By default the worker looks in .copernicus for the connection bundle. however you can also specify
+the location onf the connection bundle.
 
 ``cpc-worker -c client.cnx smp``
 
@@ -204,6 +205,7 @@ you will notice the parameter ``smp`` in the above command. This means that we
 start the worker with the platform type smp. We will cover this in greater detail
 in the section :ref:`platformtypes`.
 
+Shut down the worker simply hit ``CTRL-C``
 
 In case you try to connect with the wrong connection bundle the following
 error message will be displayed.

doc/_build/html/_sources/index.txt

@@ -77,3 +77,26 @@ of the run of a project in case things have gone wrong or if you want to test an
 
 Workflow components can actually be any type program. And with the plugin utilites
 in copernicus you can define these programs as workflow items, also known as functions.
+
+
+-------
+Authors
+-------
+
+Head authors & project leaders
+-------------------------------
+Sander Pronk |br|
+Iman Pouya (Royal Institute of Technology, Sweden) |br|
+Peter Kasson (University of Virginia, USA) |br|
+Erik Lindahl (Royal Institute of Technology, Sweden)
+
+
+Other current developers
+-------------------------
+Magnus Lundborg (Royal Institute of Technology, Sweden) |br|
+Björn Wesen (Royal Institute of Technology,Sweden)
+
+Previous developers and contributors
+------------------------------------
+Patrik Falkman |br|
+Grant Rotskoff ( University of California, Berkley, US )

doc/_build/html/getting-started.html

@@ -219,8 +219,10 @@ <h3>Optmizing the server<a class="headerlink" href="#optmizing-the-server" title
 </div>
 <div class="section" id="client-setup">
 <h2>Client Setup<a class="headerlink" href="#client-setup" title="Permalink to this headline">¶</a></h2>
-<p>To use the client, a server to connect to must first be specified. T
-o specify a server, use the <tt class="docutils literal"><span class="pre">add-server</span></tt> command:</p>
+<p>The client is a command line tool use to send commands to the server.
+it can be run directly from your laptop. But before sending commands to a server
+it needs to know its address
+This is done with the``add-server`` command:</p>
 <p><tt class="docutils literal"><span class="pre">cpcc</span> <span class="pre">add-server</span> <span class="pre">my.serverhostname.com</span></tt></p>
 <p><tt class="docutils literal"><span class="pre">cpcc</span> <span class="pre">add-server</span> <span class="pre">my.serverhostname.com</span> <span class="pre">14807</span></tt></p>
 <div class="section" id="logging-in">
@@ -249,8 +251,8 @@ <h3>Installation<a class="headerlink" href="#id3" title="Permalink to this headl
 are met no installation procedure is needed.
 To verify that the worker can connect to a server start it with</p>
 <p><tt class="docutils literal"><span class="pre">cpc-worker</span> <span class="pre">smp</span></tt></p>
-<p>this command that there is a connection bundle located in .copernicus</p>
-<p>you can also specify which bundle to use</p>
+<p>By default the worker looks in .copernicus for the connection bundle. however you can also specify
+the location onf the connection bundle.</p>
 <p><tt class="docutils literal"><span class="pre">cpc-worker</span> <span class="pre">-c</span> <span class="pre">client.cnx</span> <span class="pre">smp</span></tt></p>
 <p>When started the worker will output its Worker Id, available executables and then start
 requesting work from the server.
@@ -265,6 +267,7 @@ <h3>Installation<a class="headerlink" href="#id3" title="Permalink to this headl
 <p>you will notice the parameter <tt class="docutils literal"><span class="pre">smp</span></tt> in the above command. This means that we
 start the worker with the platform type smp. We will cover this in greater detail
 in the section <a class="reference internal" href="network/worker.html#platformtypes"><em>Platform types</em></a>.</p>
+<p>Shut down the worker simply hit <tt class="docutils literal"><span class="pre">CTRL-C</span></tt></p>
 <p>In case you try to connect with the wrong connection bundle the following
 error message will be displayed.</p>
 <div class="highlight-none"><div class="highlight"><pre>ERROR: [Errno 1] _ssl.c:503:error:14090086:

doc/_build/html/index.html

@@ -201,6 +201,26 @@ <h2>The architecture of Copernicus<a class="headerlink" href="#the-architecture-
 <p>Workflow components can actually be any type program. And with the plugin utilites
 in copernicus you can define these programs as workflow items, also known as functions.</p>
 </div>
+<div class="section" id="authors">
+<h2>Authors<a class="headerlink" href="#authors" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="head-authors-project-leaders">
+<h3>Head authors &amp; project leaders<a class="headerlink" href="#head-authors-project-leaders" title="Permalink to this headline">¶</a></h3>
+<p>Sander Pronk <br />
+Iman Pouya (Royal Institute of Technology, Sweden) <br />
+Peter Kasson (University of Virginia, USA) <br />
+Erik Lindahl (Royal Institute of Technology, Sweden)</p>
+</div>
+<div class="section" id="other-current-developers">
+<h3>Other current developers<a class="headerlink" href="#other-current-developers" title="Permalink to this headline">¶</a></h3>
+<p>Magnus Lundborg (Royal Institute of Technology, Sweden) <br />
+Björn Wesen (Royal Institute of Technology,Sweden)</p>
+</div>
+<div class="section" id="previous-developers-and-contributors">
+<h3>Previous developers and contributors<a class="headerlink" href="#previous-developers-and-contributors" title="Permalink to this headline">¶</a></h3>
+<p>Patrik Falkman <br />
+Grant Rotskoff ( University of California, Berkley, US )</p>
+</div>
+</div>
 </div>
 
 

doc/getting-started.rst

@@ -137,8 +137,10 @@ This will generate C code from Python files that will then be compiled to shared
 ------------
 Client Setup
 ------------
-To use the client, a server to connect to must first be specified. T
-o specify a server, use the ``add-server`` command:
+The client is a command line tool use to send commands to the server.
+it can be run directly from your laptop. But before sending commands to a server
+it needs to know its address
+This is done with the``add-server`` command:
 
 ``cpcc add-server my.serverhostname.com``
 
@@ -181,9 +183,8 @@ To verify that the worker can connect to a server start it with
 
 ``cpc-worker smp``
 
-this command that there is a connection bundle located in .copernicus
-
-you can also specify which bundle to use
+By default the worker looks in .copernicus for the connection bundle. however you can also specify
+the location onf the connection bundle.
 
 ``cpc-worker -c client.cnx smp``
 
@@ -204,6 +205,7 @@ you will notice the parameter ``smp`` in the above command. This means that we
 start the worker with the platform type smp. We will cover this in greater detail
 in the section :ref:`platformtypes`.
 
+Shut down the worker simply hit ``CTRL-C``
 
 In case you try to connect with the wrong connection bundle the following
 error message will be displayed.

doc/index.rst

@@ -77,3 +77,26 @@ of the run of a project in case things have gone wrong or if you want to test an
 
 Workflow components can actually be any type program. And with the plugin utilites
 in copernicus you can define these programs as workflow items, also known as functions.
+
+
+-------
+Authors
+-------
+
+Head authors & project leaders
+-------------------------------
+Sander Pronk |br|
+Iman Pouya (Royal Institute of Technology, Sweden) |br|
+Peter Kasson (University of Virginia, USA) |br|
+Erik Lindahl (Royal Institute of Technology, Sweden)
+
+
+Other current developers
+-------------------------
+Magnus Lundborg (Royal Institute of Technology, Sweden) |br|
+Björn Wesen (Royal Institute of Technology,Sweden)
+
+Previous developers and contributors
+------------------------------------
+Patrik Falkman |br|
+Grant Rotskoff ( University of California, Berkley, US )