From d3b6bdd6ef2b543c607bd7c3cdf9df5c74e90dc0 Mon Sep 17 00:00:00 2001 From: Peter Amstutz Date: Fri, 28 Aug 2020 16:01:39 -0400 Subject: [PATCH] Add missing install page for arvados-cwl-runner refs #15964 Arvados-DCO-1.1-Signed-off-by: Peter Amstutz --- .../arvados-cwl-runner.html.textile.liquid | 77 +++++++++++++++++++ 1 file changed, 77 insertions(+) create mode 100644 doc/sdk/python/arvados-cwl-runner.html.textile.liquid diff --git a/doc/sdk/python/arvados-cwl-runner.html.textile.liquid b/doc/sdk/python/arvados-cwl-runner.html.textile.liquid new file mode 100644 index 0000000000..9faedb8dc1 --- /dev/null +++ b/doc/sdk/python/arvados-cwl-runner.html.textile.liquid @@ -0,0 +1,77 @@ +--- +layout: default +navsection: sdk +navmenu: Python +title: Arvados CWL Runner +... +{% comment %} +Copyright (C) The Arvados Authors. All rights reserved. + +SPDX-License-Identifier: CC-BY-SA-3.0 +{% endcomment %} + +The Arvados FUSE driver is a Python utility that allows you to see the Keep service as a normal filesystem, so that data can be accessed using standard tools. This driver requires the Python SDK installed in order to access Arvados services. + +h2. Installation + +If you are logged in to a managed Arvados VM, the @arv-mount@ utility should already be installed. + +To use the FUSE driver elsewhere, you can install from a distribution package, or PyPI. + +h2. Option 1: Install from distribution packages + +First, "add the appropriate package repository for your distribution":{{ site.baseurl }}/install/packages.html + +{% assign arvados_component = 'python3-arvados-cwl-runner' %} + +{% include 'install_packages' %} + +h2. Option 2: Install with pip + +Run @pip install arvados-cwl-runner@ in an appropriate installation environment, such as a virtualenv. + +Note: + +The SDK uses @pycurl@ which depends on the @libcurl@ C library. To build the module you may have to first install additional packages. On Debian 9 this is: + +
+$ apt-get install git build-essential python-dev libcurl4-openssl-dev libssl1.0-dev python-llfuse
+
+ +For Python 3 this is: + +
+$ apt-get install git build-essential python3-dev libcurl4-openssl-dev libssl1.0-dev python3-llfuse
+
+ +h3. Check Docker access + +In order to pull and upload Docker images, @arvados-cwl-runner@ requires access to Docker. You do not need Docker if the Docker images you intend to use are already available in Arvados. + +You can determine if you have access to Docker by running @docker version@: + + +
~$ docker version
+Client:
+ Version:      1.9.1
+ API version:  1.21
+ Go version:   go1.4.2
+ Git commit:   a34a1d5
+ Built:        Fri Nov 20 12:59:02 UTC 2015
+ OS/Arch:      linux/amd64
+
+Server:
+ Version:      1.9.1
+ API version:  1.21
+ Go version:   go1.4.2
+ Git commit:   a34a1d5
+ Built:        Fri Nov 20 12:59:02 UTC 2015
+ OS/Arch:      linux/amd64
+
+
+ +If this returns an error, contact the sysadmin of your cluster for assistance. + +h3. Usage + +Please refer to the "Accessing Keep from GNU/Linux":{{site.baseurl}}/user/tutorials/tutorial-keep-mount-gnu-linux.html tutorial for more information. -- 2.30.2