NIH | National Cancer Institute | NCI Wiki  

Error rendering macro 'rw-search'

null

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: For HPCDATAMGM-1141: Revised to reflect data file command rather than collection command.

If your user account has the Read, Write, or Own permission level on various collections, you can download one or more of data files in those collections, from DME to a Globus endpoint. 

To download one or more collections data files to Globus:

  1. Prepare a Globus endpoint, as described in Preparing to Use Globus with DME.

  2. Consider how you want to specify the Globus endpoint:

    • If you want to use the default Globus endpoint in your hpcdme.properties file, as described in Getting Started with DME CLU, plan to omit the endpoint from the command. 
    • If you want to specify a different Globus endpoint, plan to include the endpoint in the command.
  3. Consider whether you want to download a single collection or multiple collectionsdata file or multiple data files

    • To download a single collectiondata file: Plan to specify the path for that collection in data file in the command. 
    • To download multiple collectionsdata files: In your file system, create a file that lists the paths for all of the DME collections data files you want to download, delimited by newline. Plan to use the -f option to specify that file in the command. 
  4. If you are using Cygwin on Windows and downloading multiple collectionsdata files, run the following command in Cygwin to change end-of-line delimiters from Windows standard to Unix standard in the collection file list file

    Code Block
    sed -i "s/\r$//" <collection<file-list>
  5. Run the following command:

    Code Block
    dm_download_collectiondataobject_globus [optional parameters] [collectionarchive-logical-path] <globus-destination-path> [globus-endpoint]

    The following table describes each parameter:

    ParameterDescription
    [-D <REST-response>]

    An optional parameter, specifying a path and filename in your file system. The system always creates a response file:

    • If you specify this parameter, the system saves the response from the server to the specified file in the specified location.
    • If you omit this parameter, the system saves the file as download-
    collection
    • dataobject-response-header.tmp in your home directory.
    [-o <output-json-file>]

    An optional parameter, specifying a path and filename in your file system. The system always creates an output file:

    • If you specify this parameter, the system saves the output to the specified file in the specified location.
    • If you omit this parameter, the system saves the output as download-
    collection
    • dataobject-response-message.json.tmp in your home directory.

    If the command is successful, the output file is empty.

    [-f <paths-file>]
    or
    [
    collection
    archive-
    logical-
    path]

    One or more paths within DME. Select one of the following methods to specify the

    collection

    data file or

    collections

    data files that you want to download:

    • To specify multiple
    collections
    • data files, use the -f parameter to specify a path and filename in your file system, of a file that lists the paths for all of the DME
    collections
    • data files you want to download, delimited by newline.
    • To specify a single
    collection
    • data file, specify the path for the DME
    collection
    • data file you want to download.
    <globus-destination-path>
    A path from the Globus endpoint. Specify where you want the system to create the downloaded file or files.
    [globus-endpoint]
    The UUID of the Globus endpoint that you want to use, if not the one specified in your hpcdme.properties file, as described in Getting Started with DME CLU. (The following instructions may be helpful: Copying the Globus Shared Endpoint UUID.)

The following example downloads a data.txt data file from the Project_1 collection from the PI_Lab1 collection 1 collection in DME to the root of the Globus endpoint specified in the hpcdme.properties file. 

Code Block
titleSingle Collection Example
dm_download_collectiondataobject_globus /Example_Archive/PI_Lab1/Project_1/data.txt /

For another example, consider the following command.

Code Block
titleMultiple Collections Example
dm_download_collectiondataobject_globus -f collectionfile-list.txt /

With the following code in the specified collectionfile-list.txt file, the above command downloads multiple collections multiple data files from various locations in DME.

Code Block
titleContents of collection-list.txt File
/Example_Archive/PI_Lab2/Project_1
/data.txt /Example_Archive/PI_Lab2/Project_2
/image.jpg /Example_Archive/PI_Lab3/Project_1/image.png

For instructions on performing similar tasks in the GUI, refer to Downloading Data via the GUI.  

...