NIH | National Cancer Institute | NCI Wiki  

Error rendering macro 'rw-search'

null

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 13 Next »

If your user account has the Read, Write, or Own permission level on various collections, you can download those collections, from DME to a Globus endpoint. For prerequisites, refer to  Preparing to Use Globus with DME.

To download multiple collections to Globus:

  1. 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.
  2. Run the following command:

    dm_download_collection_async [optional parameters] [collection-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-dataobject- or download-collection-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-dataobject- or download-collection-response-message.json.tmp in your home directory.

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

    [-f <paths-file>]

    or

    [collection-logical-path]

    One or more paths within DME. Specify the collection or collections that you want to download:

    • To specify multiple collections,
    • To specify a single collection,
    <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 .)

[-D REST-response] : Optional, saves the response from the server to the specified file.
[-o output-json-file] : Optional, saves the output to the specified file.
[-f paths-file] : New line delimited file which contains the collection paths in DME to be downloaded. (Not needed if downloading a single collection using collection-logical-path parameter instead.)
[collection-logical-path] : Collection path in DME. (Not needed if the paths-file parameter is provided.)
<globus-destination-path> : Path from the Globus endpoint where the collection(s) shall be downloaded. (This is a mandatory parameter.)
[globus-endpoint] : Optional Globus endpoint uuid if specifying other than the default endpoint.

This command can be used to download a single collection or a list of collections provided in a file. (New line delimited.)

Single collection example:
dm_download_collection_async /Example_Archive/PI_Lab1/Project_1 /

Multiple collections example:
collection-list.txt
/Example_Archive/PI_Lab1/Project_1
/Example_Archive/PI_Lab1/Project_2
/Example_Archive/PI_Lab2/Project_1

dm_download_collection_async -f collection-list.txt /

  • No labels