Fix 2.4.2 upgrade notes formatting refs #19330
[arvados.git] / doc / sdk / python / arvados-cwl-runner.html.textile.liquid
1 ---
2 layout: default
3 navsection: sdk
4 navmenu: Python
5 title: Arvados CWL Runner
6 ...
7 {% comment %}
8 Copyright (C) The Arvados Authors. All rights reserved.
9
10 SPDX-License-Identifier: CC-BY-SA-3.0
11 {% endcomment %}
12
13 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.
14
15 h2. Installation
16
17 If you are logged in to a managed Arvados VM, the @arv-mount@ utility should already be installed.
18
19 To use the FUSE driver elsewhere, you can install from a distribution package, or PyPI.
20
21 h2. Option 1: Install from distribution packages
22
23 First, "add the appropriate package repository for your distribution":{{ site.baseurl }}/install/packages.html
24
25 {% assign arvados_component = 'python3-arvados-cwl-runner' %}
26
27 {% include 'install_packages' %}
28
29 h2. Option 2: Install with pip
30
31 Run @pip install arvados-cwl-runner@ in an appropriate installation environment, such as a virtualenv.
32
33 Note:
34
35 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 10 this is:
36
37 <pre>
38 $ apt-get install git build-essential python3-dev libcurl4-openssl-dev libssl1.0-dev python3-llfuse
39 </pre>
40
41 h3. Check Docker access
42
43 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.
44
45 You can determine if you have access to Docker by running @docker version@:
46
47 <notextile>
48 <pre><code>~$ <span class="userinput">docker version</span>
49 Client:
50  Version:      1.9.1
51  API version:  1.21
52  Go version:   go1.4.2
53  Git commit:   a34a1d5
54  Built:        Fri Nov 20 12:59:02 UTC 2015
55  OS/Arch:      linux/amd64
56
57 Server:
58  Version:      1.9.1
59  API version:  1.21
60  Go version:   go1.4.2
61  Git commit:   a34a1d5
62  Built:        Fri Nov 20 12:59:02 UTC 2015
63  OS/Arch:      linux/amd64
64 </code></pre>
65 </notextile>
66
67 If this returns an error, contact the sysadmin of your cluster for assistance.
68
69 h3. Usage
70
71 Please refer to the "Accessing Keep from GNU/Linux":{{site.baseurl}}/user/tutorials/tutorial-keep-mount-gnu-linux.html tutorial for more information.