TCIA Online Help

Space shortcuts

Versions Compared

Old Version 8

changes.mady.by.user Carolyn Klinger

Saved on

compared with

New Version 9

changes.mady.by.user Carolyn Klinger

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Panel

Table of Contents

The NBIA Data Retriever is a software product you can download and install so that you can download radiology images from from the TCIA Radiology Portal. 

Installing the NBIA Data Retriever on Linux

If you are using Linux, you can alternatively access NBIA Data Retriever's command-line interface, which does not require the desktop environment.

If you do not already have the NBIA Data Retriever installed on your Linux machine, do refer to the following Python code.

Code Block
# install NBIA Data Retriever command line software for downloading images 
!mkdir # install NBIA Data Retriever command-line software for downloading images 
!mkdir /usr/share/desktop-directories/
!wget wget -P P /content/NBIA-Data-Retriever httpsRetriever https://cbiit-download.nci.nih.gov/nbia/releases/ForTCIA/NBIADataRetriever_4.2/nbia-data-retriever-4.2.deb
!dpkg dpkg -i i /content/NBIA-Data-Retriever/nbia-data-retriever-4.2.deb
# If you are using a machine that doesn't support .deb packages, you can change the wget line above to point to https://cbiit-download.nci.nih.gov/nbia/releases/ForTCIA/NBIADataRetriever_4.2/NBIADataRetriever-4.2-1.x86_64.rpm.

Running the NBIA Data Retriever on Linux

Note

In the two sample commands that follow, the -l <credential file> option is only required when the manifest file contains series from restricted collections. It is unnecessary when the manifest file only contains series from public collections.

  • To run the NBIA Data Retriever on CentOS, run the following sample command.

    Code Block
    /opt/NBIADataRetriever/NBIADataRetriever --cli <location>/<manifest file name>.tcia -d <parent location>/<download directory> -l <location>/<credential file> -v –f


  • To run the NBIA Data Retriever on Ubuntu, run the following sample command.

    Code Block
    /opt/nbia-data-retriever/nbia-data-retriever --cli <location>/<manifest file name>.tcia -d <parent location>/<download directory> -l <location>/<credential file> -v –f


    Tip

    A credential file is a text file that passes the user's credentials in the following format:

    Code Block
    userName=YourUserName
passWord=YourPassword

    The parameters "userName" and "passWord" are case-sensitive.


Command-Line Interface Parameters

The options available for the command line interface are described in the following table.

...