Use the Python Run Downloader

To download files associated with a BaseSpace Run, use a Python script with the Run ID and your account access token. This example uses the BaseSpace Run Downloader script.

The downloader script is provided AS-IS without any warranty of any kind. Illumina is not responsible for any loss of data, incorrect results, or any costs, liabilities, or damages that may result from the use of this script.

  1. Download the script and unzip the files to an empty directory.
    The runfolder downloads to the same directory that the script is executed from. Make sure that you have enough space in the directory for the downloaded runs.
  2. Go to https://developer.basespace.illumina.com/ and log in.
  3. From the toolbar, select My Apps.
  4. In the applications tab, select Create a New Application.
  5. Fill out the Applications Details and then select Create Application.
  6. On the application page, select the Credentials tab and copy the Access Token.
  7. Create a new text file to serve as a script to run the python run downloader.

    1. Name the file as desired with an extension appropriate to the operating system:
      • Windows batch file (*.bat)
      • Linux shell script (*.sh)
    2. Copy the access token and Run ID to the Windows batch file or Linux script. The Run ID can be obtained from the URL for the desired run.

    Example Windows batch file/Linux shell script (single line):

    python BaseSpaceRunDownloader_v2.py -r <Run ID> -a <access token>
    
  8. Run the script.
    When the script executes, the runfolder files appear in a new output directory.
GitHub

Contribute to this article

Want to edit or suggest changes to this content? You can do so using GitHub.