NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

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

...

  • 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
    Tip

    The -l <credential file> option is required when the manifest file contains series from restricted collections but unnecessary if the manifest file only contains public data.

  • 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

    The -l <credential file> option is required when the manifest file contains series from restricted collections, and is unnecessary when the manifest file contains series from public collections only.

    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.

...

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>

Mandatory Required when the manifest file has series that belong to a private collectionfrom restricted collections.

Optional for a when the manifest file with only public datahas 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.