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. This guide documents the command-line interface (CLI) of the NBIA Data Retriever
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.
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 for operating systems that don't support *.deb packages.
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.
/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.
/opt/nbia-data-retriever/nbia-data-retriever --cli <location>/<manifest file name>.tcia -d <parent location>/<download directory> -l <location>/<credential file> -v –f |
A credential file is a text file that passes the user's credentials in the following format:
The parameters "userName" and "passWord" are case-sensitive. |
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.
Option | Description |
---|---|
-c, -C, --cli, --CLI | Indicates running as a CLI app |
-d, -D <download directory> | Required. The user must have write permission for the directory specified with this option. |
-f, -F | Skip 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, -Q | Quiet. Default is false |
-u, -U <user name> | Optional |
-v, -V | Verbose. Default is false. |
If your download is interrupted due to errors or any other reason, you can resume the download using the CLI.
To resume the interrupted download, do the following.