2. Downloading data with Aspera



Recipe Overview
Reading Time
15 minutes
Executable Code
Yes
Difficulty
Downloading data with Aspera
FAIRPlus logo
Recipe Type
Hands-on
Audience
Principal Investigator, Data Manager, Data Scientist

2.1. Main objectives

This recipe covers documentation of the popular Aspera Fast Transfer Protocol and complements related recipes concerned with efficient files uploads and downloads . While the Aspera protocol is used by major public scientific data repositories such as NCBI SRA and EMBL ENA, it is important to note that the communication protocol is proprietary. The recipe will therefore also cover some of the implications of using a closed protocol in terms of achieving FAIR compliance.

2.2. Graphical overview

Aspera Data Transfer Process.

Fig. 2.1 Aspera Data Transfer Process.


2.3. Obtain Aspera services

2.3.1. Get accounts permissions

  • Apply for access

  • Pay attention to the conditions

  • Sign up if you are the appropriate person for this download/upload

  • Typically Aspera sites are locked down and need a username and password.

  • For some sites, local rules are in place covering user access. For example only one username may be allowed per organisation, and the users must have demonstrable technical competencies and necessary familiarity with the data, and rules should be in place how to distribute the downloaded data further.

2.3.2. Decide how you are going to access the data

  • A Web browser is great for initial browsing and downloading of small occasional files. It will automatically prompt you to download the Aspera broswer plugin to be able to do download any files.

  • For heavy duty downloading an Aspera command line client is needed. e.g. to download gigabytes or even terabytes of data.

2.3.3. Decide on software needed and get it installed

2.3.3.1. Get the firewall configured as required to allow downloading and or uploading

  • You may need to have firewall exceptions raised to unblock ports 3301 and 22, with your organisation IT’s network perimeter team.

  • Try connecting first in case they are already not blocked

2.3.3.2. Work out the appropriate command line options

  • For the Aspera command line, there are a large variety of options for downloading and uploading. See the download documentation above.

  • Considerations:

    • Use the -k {1,2,3} option to allow restarts without re-downloading all the data.

    • Run it using something like screen, so that it can be running in the background on a server

    • On the command line you can choose a preferred transfer rate. Please be careful to not hog the network bandwidth (we found up to about 100Mbps is okay).

2.3.3.3. Worked-out example for downloading

  • These are the download command options we used. (and both ports 3301 and 22 were unblocked)

#set the password variable corresponding to your Aspera account.
export ASPERA_SCP_FILEPASS="mypassword"
 
#example to download the files recursively from a specific directory on the Aspera server to
$ /hpc/apps/current/aspera/v3.9.6.app/bin/ascp -k 1 -P 33001  -o FileCrypt=decrypt aspera.myacc@aspera-immport.niaid.nih.gov:dir_to_download ./
  • Ascp Version we used:

$ ascp --version
IBM Aspera Desktop Client version 3.9.6.176292
ascp version 3.9.6.176292
...

2.3.4. Monitoring connections and file transfers

  • Observe the download/upload speed e.g. 100Mbs and then you can estimate the finish time

  • Have some automated monitoring on the download process to notify you if it stops/finishes. Even an hourly du -sh from a cron job

  • Also typically you are pulling down many directories and files. On completion, it may be worth doing a recursive file listing to a file e.g. ls -ltR > file_listing.txt to give you and your “customers” a simple file catalogue.

2.3.5. Considerations for uploading

  • For uploading much of the above applies. The main differences are:

    • be aware of geographical zoning and which areas to upload to

    • prepare data for ease of tranfer, for instance, organize data in directories or consider data compression prior to transfer (note that this transfers a computational burden of decompression).

2.4. Conclusion

  • Aspera is commercial software

  • Is this still okay as part of FAIR principles? As long as the instution with the server has paid for the licence, clients for the protocol are available at no fee.


2.5. Authors

Name

ORCID

Affiliation

Type

ELIXIR Node

Contribution

GSK

Writing - Original Draft

University of Oxford

Writing - Review & Editing, Conceptualization


2.6. License

This page is released under the Creative Commons 4.0 BY license.