Man pages sections > man1 > datalad-install

datalad-install

datalad-install(1) General Commands Manual datalad-install(1)

SYNOPSIS


datalad-install [--version] [-h] [-l LEVEL] [-p {condor}] [-s SOURCE]
[-d DATASET] [-g] [-D DESCRIPTION] [-r]
[--recursion-limit LEVELS]
[--if-dirty {fail,save-before,ignore}] [--nosave] [--reckless]
[--git-opts STRING] [--git-clone-opts STRING]
[--annex-opts STRING] [--annex-init-opts STRING] [-J NJOBS]
[PATH [PATH ...]]
 
 

DESCRIPTION

Install a dataset from a (remote) source.
 
 
 
This command creates a local sibling of an existing dataset from a
 
(remote) location identified via a URL or path. Optional recursion into
 
potential subdatasets, and download of all referenced data is supported.
 
The new dataset can be optionally registered in an existing
 
superdataset by identifying it via the DATASET argument (the new
 
dataset's path needs to be located within the superdataset for that).
 
 
 
It is recommended to provide a brief description to label the dataset's
 
nature *and* location, e.g. "Michael's music on black laptop". This helps
 
humans to identify data locations in distributed scenarios. By default an
 
identifier comprised of user and machine name, plus path will be generated.
 
 
 
When only partial dataset content shall be obtained, it is recommended to
 
use this command without the GET-DATA flag, followed by a
 
`get` operation to obtain the desired data.
 
 
 
NOTE
 

Power-user info: This command uses git clone, and
 

git annex init to prepare the dataset. Registering to a
 

superdataset is performed via a git submodule add operation
 

in the discovered superdataset.

OPTIONS


PATH path/name of the installation target. If no PATH is
provided a destination path will be derived from a
source URL similar to git clone. [Default: None]
 

--version show the program's version and license information
-h, --help, --help-np
show this help message. --help-np forcefully disables
the use of a pager for displaying the help message
-l LEVEL, --log-level LEVEL
set logging verbosity level. Choose among critical,
error, warning, info, debug. Also you can specify an
integer <10 to provide even more debugging information
-p {condor}, --pbs-runner {condor}
execute command by scheduling it via available PBS.
For settings, config file will be consulted
-s SOURCE, --source SOURCE
URL or local path of the installation source.
Constraints: value must be a string [Default: None]
-d DATASET, --dataset DATASET
specify the dataset to perform the install operation
on. If no dataset is given, an attempt is made to
identify the dataset in a parent directory of the
current working directory and/or the PATH given.
Constraints: Value must be a Dataset or a valid
identifier of a Dataset (e.g. a path) [Default: None]
-g, --get-data
if given, obtain all data content too. [Default:
False]
-D DESCRIPTION, --description DESCRIPTION
short description of this dataset instance that humans
can use to identify the repository/location, e.g.
"Precious data on my laptop. Constraints: value must
be a string [Default: None]
-r, --recursive
if set, recurse into potential subdataset. [Default:
False]
--recursion-limit LEVELS
limit recursion into subdataset to the given number of
levels. Constraints: value must be convertible to type
'int' [Default: None]
--if-dirty {fail,save-before,ignore}
desired behavior if a dataset with unsaved changes is
discovered: 'fail' will trigger an error and further
processing is aborted; 'save-before' will save all
changes prior any further action; 'ignore' let's
datalad proceed as if the dataset would not have
unsaved changes. [Default: 'save-before']
--nosave by default all modifications to a dataset are
immediately saved. Given this option will disable this
behavior. [Default: True]
--reckless Set up the dataset to be able to obtain content in the
cheapest/fastest possible way, even if this poses a
potential risk the data integrity (e.g. hardlink files
from a local clone of the dataset). Use with care, and
limit to "read-only" use cases. With this flag the
installed dataset will be marked as untrusted.
[Default: False]
--git-opts STRING
option string to be passed to git calls. Constraints:
value must be a string [Default: None]
--git-clone-opts STRING
option string to be passed to git clone calls.
Constraints: value must be a string [Default: None]
--annex-opts STRING
option string to be passed to git annex calls.
Constraints: value must be a string [Default: None]
--annex-init-opts STRING
option string to be passed to git annex init calls.
Constraints: value must be a string [Default: None]
-J NJOBS, --jobs NJOBS
how many parallel jobs (where possible) to use.
Constraints: value must be convertible to type 'int'
[Default: None]

AUTHORS


datalad is developed by The DataLad Team and Contributors <team@datalad.org>.
2016-11-10 datalad-install 0.4.1