datalad download-cds
Synopsis
datalad download-cds [-h] [-O PATH] [-d PATH] [-m MESSAGE] [--batch] [--lazy] [--nosave] [--version] spec
Description
Downloads specified datasets from the CDS data store
Options
spec
A json string or python dictionary containing the key "dataset" with the datasets name (i.e. what is shown as the first parameter to cdsapi.Client.retrieve if you do a "Show API request" on some dataset in the CDS) and the key "sub-selection" with the sub-selection of the dataset that should be fetched (i.e. what is shown as the second parameter to cdsapi.Client.retrieve).
-h, --help, --help-np
show this help message. --help-np forcefully disables the use of a pager for displaying the help message
-O PATH, --path PATH
target path to download to. Constraints: value must be a string
-d PATH, --dataset PATH
specify the dataset to add files to. If no dataset is given, an attempt is made to identify the dataset based on the current working directory. Use --nosave to prevent adding files to the dataset. Constraints: Value must be a Dataset or a valid identifier of a Dataset (e.g. a path) or value must be NONE
-m MESSAGE, --message MESSAGE
a description of the state or the changes made to a dataset. Constraints: value must be a string or value must be NONE
--batch
By default a single call to git annex addurl will be made for each request to download. The batch option can be supplied to instead re-use a git annex addurl --batch process for multiple consecutive calls to download-cds. This is only useful when used with the python API.
--lazy
By default the file will be immediately downloaded. If the lazy flag is supplied then the CDS request is only recorded as a source for the file, but no download is initiated. Keep in mind that there is no way to validate the correctness of the request if the lazy flag is used.
--nosave
by default all modifications to a dataset are immediately saved. Giving this option will disable this behavior.
--version
show the module and its version which provides the command