Versions Compared

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 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, refer to the following commands.

Code Block
titleInstalling the NBIA Data Retriever DEB package
mkdir /usr/share/desktop-directories/
wget -P ~/NBIA-Data-Retriever https://cbiit-download.nci.nih.gov/nbia/releases/ForTCIA/NBIADataRetriever_4.2/nbia-data-retriever-4.2.deb
dpkg -i ~/NBIA-Data-Retriever/nbia-data-retriever-4.2.deb

Note that an RPM package is also available at https://cbiit-download.nci.nih.gov/nbia/releases/ForTCIA/NBIADataRetriever_4.2/NBIADataRetriever-4.2-1.x86_64.rpm for operating systems that don't support *.deb packages.

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.

if you use the Data Retriever CLI with option  -v, -f, or -q, and want to access restricted collection(s), put these options after the user credential parameters.

OptionDescription
-c, -C, --cli, --CLIIndicates running as a CLI app
-d, -D < download directory>Optional. Default is the current directory.
-f, -FSkip the series the user does not have access to. Force the user to download the series if the user has access. Default is false.
-l <credential file>

Required when the manifest file has series from restricted collections.

Optional when the manifest file has series from public collections only.

-m, -M, --md5, –MD5 Enable validation of the checksums of the downloaded files. Default is that checksums will not be validated.
-p, -P <password>Optional
-q, -QQuiet. Default is false
-u, -U <user name>Optional
-v, -VVerbose. Default is false.