X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/6a59d473c1574eec4db1f83b5d1a963b4f976e5a..a3548962424791bf575eb1ef68aac09b785cfdbd:/doc/user/tutorials/tutorial-keep-get.html.textile.liquid diff --git a/doc/user/tutorials/tutorial-keep-get.html.textile.liquid b/doc/user/tutorials/tutorial-keep-get.html.textile.liquid index 1e894e7c25..5fa31970c4 100644 --- a/doc/user/tutorials/tutorial-keep-get.html.textile.liquid +++ b/doc/user/tutorials/tutorial-keep-get.html.textile.liquid @@ -3,14 +3,45 @@ layout: default navsection: userguide title: "Downloading data" ... +{% comment %} +Copyright (C) The Arvados Authors. All rights reserved. + +SPDX-License-Identifier: CC-BY-SA-3.0 +{% endcomment %} Arvados Data collections can be downloaded using either the arv commands or using Workbench. -# "*Downloading using arv commands*":#download-using-arv -# "*Downloading using Workbench*":#download-using-workbench -# "*Downloading a shared collection using Workbench*":#download-shared-collection +# "*Download using Workbench*":#download-using-workbench +# "*Creating a special download URL for a collection*":#download-shared-collection +# "*Download using command line tools*":#download-using-arv + +h2(#download-using-workbench). Download using Workbench + +You can also download Arvados data collections using the Workbench. + +When you visit a project in Workbench (for instance, the *Home Projects* or any projects under it), the collections will show up on the project details page, with "_Data collection_" in the *Type* column. + +Clicking on a collection will bring you to its details page. There, the lower panel acts like a file manager where you can navigate to or search for files, select them for actions, and download them. + +To download a file, simply click on the file, or bring up the context menu using right-click or the triple-dot button on its row, and then select the menu item *Download*. + +h2(#download-shared-collection). Creating a special download URL for a collection + +To share a collection with users that do not have an account on your Arvados cluster, locate the collection and then go to the *Sharing settings* dialog box as described above. There, select the *SHARING URLS* tab. + +You can then generate a new sharing URL using the CREATE SHARING URL button, with the option to set an expiration time for the URL. You can then copy the URL to the clipboard for sharing with others. To revoke (that is, delete) a sharing URL, click on the cross icon beside it. + +
!{width: 80%}{{ site.baseurl }}/images/sharing-collection-url.png!
_The_ *SHARING URLS* _tab in the_ *Sharing settings* _dialog box, showing the created URL with an expiration time_
+ +Any user with the sharing URL can download this collection by simply accessing this URL using browser. It will present a downloadable version of the collection as shown below. + +!{display: block;margin-left: 25px;margin-right: auto;border:1px solid lightgray;}{{ site.baseurl }}/images/download-shared-collection.png! + +When a collection is being shared by URL, in the *WITH USERS/GROUS* tab of *Sharing settings*, the following message will appear if *General access* is Private: _Although there aren't specific permissions set, this is publicly accessible via Sharing URL(s)._ + +* *Note:* Sharing by URL is specific to collections. Projects or individual files cannot be shared in this way. -h2(#download-using-arv). Downloading using arv commands +h2(#download-using-arv). Download using command line tools {% include 'tutorial_expectations' %} @@ -19,61 +50,47 @@ You can download Arvados data collections using the command line tools @arv-ls@ Use @arv-ls@ to view the contents of a collection: -
~$ arv-ls c1bad4b39ca5a924e481008009d94e32+210
-var-GS000016015-ASM.tsv.bz2
+
~$ arv-ls ae480c5099b81e17267b7445e35b4bc7+180
+./HWI-ST1027_129_D0THKACXX.1_1.fastq
+./HWI-ST1027_129_D0THKACXX.1_2.fastq
 
-
~$ arv-ls 887cd41e9c613463eab2f0d885c6dd96+83
-alice.txt
-bob.txt
-carol.txt
-
- - -Use @-s@ to print file sizes rounded up to the nearest kilobyte: +Use @-s@ to print file sizes, in kilobytes, rounded up: -
~$ arv-ls -s c1bad4b39ca5a924e481008009d94e32+210
-221887 var-GS000016015-ASM.tsv.bz2
+
~$ arv-ls -s ae480c5099b81e17267b7445e35b4bc7+180
+     12258 ./HWI-ST1027_129_D0THKACXX.1_1.fastq
+     12258 ./HWI-ST1027_129_D0THKACXX.1_2.fastq
 
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): -
~$ arv-get c1bad4b39ca5a924e481008009d94e32+210/ .
-~$ ls var-GS000016015-ASM.tsv.bz2
-var-GS000016015-ASM.tsv.bz2
+
~$ $ arv-get ae480c5099b81e17267b7445e35b4bc7+180/ .
+23 MiB / 23 MiB 100.0%
+~$ ls
+HWI-ST1027_129_D0THKACXX.1_1.fastq  HWI-ST1027_129_D0THKACXX.1_2.fastq
 
You can also download individual files: -
~$ arv-get 887cd41e9c613463eab2f0d885c6dd96+83/alice.txt .
+
~$ arv-get ae480c5099b81e17267b7445e35b4bc7+180/HWI-ST1027_129_D0THKACXX.1_1.fastq .
+11 MiB / 11 MiB 100.0%
 
-h2(#download-using-workbench). Downloading using Workbench - -You can also download Arvados data collections using the Workbench. - -Visit the Workbench *Dashboard*. Click on *Projects* 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. - -You can access the contents of a collection by clicking on the * 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. - -You can now download the collection files by clicking on the button(s). +h3. Federated downloads -h2(#download-shared-collection). Downloading a shared collection using Workbench +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). -Collections can be shared to allow downloads by anonymous users. +If you request a collection by portable data hash, it will first search the home cluster, then search federated clusters. -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 Create sharing link button. +You may also request a collection by UUID. In this case, it will contact the cluster named in the UUID prefix (in this example, @zzzzz@). -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. - -!{display: block;margin-left: 25px;margin-right: auto;border:1px solid lightgray;}{{ site.baseurl }}/images/shared-collection.png! - -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. - -!{display: block;margin-left: 25px;margin-right: auto;border:1px solid lightgray;}{{ site.baseurl }}/images/download-shared-collection.png! + +
~$ arv-get zzzzz-4zz18-fw6dnjxtkvzdewt/ .
+
+