6093: a few more updates
authorradhika <radhika@curoverse.com>
Tue, 26 May 2015 19:51:44 +0000 (15:51 -0400)
committerradhika <radhika@curoverse.com>
Tue, 26 May 2015 19:51:44 +0000 (15:51 -0400)
doc/_includes/_tutorial_expectations_workstation.liquid [new file with mode: 0644]
doc/user/topics/arv-docker.html.textile.liquid
doc/user/topics/arv-web.html.textile.liquid
doc/user/topics/run-command.html.textile.liquid
doc/user/topics/tutorial-parallel.html.textile.liquid

diff --git a/doc/_includes/_tutorial_expectations_workstation.liquid b/doc/_includes/_tutorial_expectations_workstation.liquid
new file mode 100644 (file)
index 0000000..75fb256
--- /dev/null
@@ -0,0 +1,3 @@
+{% include 'notebox_begin' %}
+This tutorial assumes that you have installed the Arvados "Command line SDK":{{site.baseurl}}/sdk/cli/install.html and "Python SDK":{{site.baseurl}}/sdk/python/sdk-python.html on your workstation and have a "working environment.":{{site.baseurl}}/user/getting_started/check-environment.html
+{% include 'notebox_end' %}
index 0a0693f3d28af21ff03bb32c80446ce89480f34c..821b105b5fc9405becb34da2a50cf7353e7a82ee 100644 (file)
@@ -14,7 +14,7 @@ This page will demonstrate how to:
 # Upload that image to Arvados for use by Crunch jobs
 # Share your image with others
 
-{% include 'tutorial_expectations' %}
+{% include 'tutorial_expectations_workstation' %}
 
 You also need ensure that "Docker is installed,":https://docs.docker.com/installation/ the Docker daemon is running, and you have permission to access Docker.  You can test this by running @docker version@.  If you receive a permission denied error, your user account may need to be added to the @docker@ group.  If you have root access, you can add yourself to the @docker@ group using @$ sudo addgroup $USER docker@ then log out and log back in again; otherwise consult your local sysadmin.
 
@@ -197,6 +197,6 @@ h2. Share Docker images
 Docker images are subject to normal Arvados permissions.  If wish to share your Docker image with others (or wish to share a pipeline template that uses your Docker image) you will need to use @arv keep docker@ with the @--project-uuid@ option to upload the image to a shared project.
 
 <notextile>
-<pre><code>$ <span class="userinput">arv keep docker --project-uuid zzzzz-j7d0g-u7zg1qdaowykd8d arvados/jobs-with-r</span>
+<pre><code>$ <span class="userinput">arv keep docker --project-uuid qr1hi-j7d0g-xxxxxxxxxxxxxxx arvados/jobs-with-r</span>
 </code></pre>
 </notextile>
index cf3a3cc950fe2d51adddf56803da25700af83650..44e5fd8f3e6e677a98fbd26d099f3ce3d5bb2700 100644 (file)
@@ -6,11 +6,14 @@ title: "Using arv-web"
 
 @arv-web@ enables you to run a custom web service from the contents of an Arvados collection.
 
+{% include 'tutorial_expectations_workstation' %}
+
 h2. Usage
 
 @arv-web@ enables you to set up a web service based on the most recent collection in a project.  An arv-web application is a reproducible, immutable application bundle where the web app is packaged with both the code to run and the data to serve.  Because Arvados Collections can be updated with minimum duplication, it is efficient to produce a new application bundle when the code or data needs to be updated; retaining old application bundles makes it easy to go back and run older versions of your web app.
 
 <pre>
+$ cd $HOME/arvados/services/arv-web
 usage: arv-web.py [-h] --project-uuid PROJECT_UUID [--port PORT]
                   [--image IMAGE]
 
index 5ffeb1836701dc83735e0377af0ce72ed228ff19..f02a6e6f5af207d85b757402441a968a23c804b2 100644 (file)
@@ -6,6 +6,8 @@ title: "run-command reference"
 
 The @run-command@ crunch script enables you run command line programs.
 
+{% include 'tutorial_expectations_workstation' %}
+
 h1. Using run-command
 
 The basic @run-command@ process evaluates its inputs and builds a command line, executes the command, and saves the contents of the output directory back to Keep.  For large datasets, @run-command@ can schedule concurrent tasks to execute the wrapped program over a range of inputs (see @task.foreach@ below.)
index 7a430a9471ab8a5b09f74630287ee5d415e52343..6d0058b5e950e8c1b0866158ee815a859fcef4a4 100644 (file)
@@ -4,7 +4,7 @@ navsection: userguide
 title: "Concurrent Crunch tasks"
 ...
 
-In the previous tutorials, we used @arvados.job_setup.one_task_per_input_file()@ to automatically create concurrent jobs by creating a separate task per file.  For some types of jobs, you may need to split the work up differently, for example creating tasks to process different segments of a single large file.  In this this tutorial will demonstrate how to create Crunch tasks directly.
+In the previous tutorials, we used @arvados.job_setup.one_task_per_input_file()@ to automatically create concurrent jobs by creating a separate task per file.  For some types of jobs, you may need to split the work up differently, for example creating tasks to process different segments of a single large file.  This tutorial will demonstrate how to create Crunch tasks directly.
 
 Start by entering the @crunch_scripts@ directory of your Git repository: