doc/user/tutorials/tutorial-keep-get.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: userguide
   4 title: "Downloading data"
   5 ...
   6 {% comment %}
   7 Copyright (C) The Arvados Authors. All rights reserved.
   8
   9 SPDX-License-Identifier: CC-BY-SA-3.0
  10 {% endcomment %}
  11
  12 Arvados Data collections can be downloaded using either the arv commands or using Workbench.
  13
  14 # "*Downloading using arv commands*":#download-using-arv
  15 # "*Downloading using Workbench*":#download-using-workbench
  16 # "*Downloading a shared collection using Workbench*":#download-shared-collection
  17
  18 h2(#download-using-arv). Downloading using arv commands
  19
  20 {% include 'tutorial_expectations' %}
  21
  22 You can download Arvados data collections using the command line tools @arv-ls@ and @arv-get@.
  23
  24 Use @arv-ls@ to view the contents of a collection:
  25
  26 <notextile>
  27 <pre><code>~$ <span class="userinput">arv-ls c1bad4b39ca5a924e481008009d94e32+210</span>
  28 var-GS000016015-ASM.tsv.bz2
  29 </code></pre>
  30
  31 <pre><code>~$ <span class="userinput">arv-ls 887cd41e9c613463eab2f0d885c6dd96+83</span>
  32 alice.txt
  33 bob.txt
  34 carol.txt
  35 </code></pre>
  36 </notextile>
  37
  38 Use @-s@ to print file sizes rounded up to the nearest kilobyte:
  39
  40 <notextile>
  41 <pre><code>~$ <span class="userinput">arv-ls -s c1bad4b39ca5a924e481008009d94e32+210</span>
  42 221887 var-GS000016015-ASM.tsv.bz2
  43 </code></pre>
  44 </notextile>
  45
  46 Use @arv-get@ to download the contents of a collection and place it in the directory specified in the second argument (in this example, @.@ for the current directory):
  47
  48 <notextile>
  49 <pre><code>~$ <span class="userinput">arv-get c1bad4b39ca5a924e481008009d94e32+210/ .</span>
  50 ~$ <span class="userinput">ls var-GS000016015-ASM.tsv.bz2</span>
  51 var-GS000016015-ASM.tsv.bz2
  52 </code></pre>
  53 </notextile>
  54
  55 You can also download individual files:
  56
  57 <notextile>
  58 <pre><code>~$ <span class="userinput">arv-get 887cd41e9c613463eab2f0d885c6dd96+83/alice.txt .</span>
  59 </code></pre>
  60 </notextile>
  61
  62 h3. Federated downloads
  63
  64 If your cluster is "configured to be part of a federation":{{site.baseurl}}/admin/federation.html you can also download collections hosted on other clusters (with appropriate permissions).
  65
  66 If you request a collection by portable data hash, it will first search the home cluster, then search federated clusters.
  67
  68 You may also request a collection by UUID.  In this case, it will contact the cluster named in the UUID prefix (in this example, @qr1hi@).
  69
  70 <notextile>
  71 <pre><code>~$ <span class="userinput">arv-get qr1hi-4zz18-fw6dnjxtkvzdewt/ .</span>
  72 </code></pre>
  73 </notextile>
  74
  75 h2(#download-using-workbench). Downloading using Workbench
  76
  77 You can also download Arvados data collections using the Workbench.
  78
  79 Visit the Workbench *Dashboard*. Click on *Projects*<span class="caret"></span> dropdown menu in the top navigation menu, select your *Home* project. You will see the *Data collections* tab, which lists the collections in this project.
  80
  81 You can access the contents of a collection by clicking on the *<i class="fa fa-fw fa-archive"></i> Show* button next to the collection. This will take you to the collection's page. Using this page you can see the collection's contents, download individual files, and set sharing options.
  82
  83 You can now download the collection files by clicking on the <span class="btn btn-sm btn-info"><i class="fa fa-download"></i></span> button(s).
  84
  85 h2(#download-shared-collection). Downloading a shared collection using Workbench
  86
  87 Collections can be shared to allow downloads by anonymous users.
  88
  89 To share a collection with anonymous users, visit the collection page using Workbench as described in the above section. Once on this page, click on the <span class="btn btn-sm btn-primary" >Create sharing link</span> button.
  90
  91 This will create a sharing link for the collection as shown below. You can copy the sharing link in this page and share it with other users.
  92
  93 !{display: block;margin-left: 25px;margin-right: auto;border:1px solid lightgray;}{{ site.baseurl }}/images/shared-collection.png!
  94
  95 A user with this url can download this collection by simply accessing this url using browser. It will present a downloadable version of the collection as shown below.
  96
  97 !{display: block;margin-left: 25px;margin-right: auto;border:1px solid lightgray;}{{ site.baseurl }}/images/download-shared-collection.png!