1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
|
.. -*- mode: rst; fill-column: 78; indent-tabs-mode: nil -*-
.. vi: set ft=rst sts=4 ts=4 sw=4 et tw=79:
### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ###
#
# See COPYING file distributed along with the datalad package for the
# copyright and license terms.
#
### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ###
.. _chap_glossary:
********
Glossary
********
DataLad purposefully uses a terminology that is different from the one used by
its technological foundations Git_ and git-annex_. This glossary provides
definitions for terms used in the datalad documentation and API, and relates
them to the corresponding Git_/git-annex_ concepts.
.. glossary::
:sorted:
dataset
A regular Git_ repository with an (optional) :term:`annex`.
subdataset
A :term:`dataset` that is part of another dataset, by means of being
tracked as a Git_ submodule. As such, a subdataset is also a complete
dataset and not different from a standalone dataset.
superdataset
A :term:`dataset` that contains at least one :term:`subdataset`.
sibling
A :term:`dataset` (location) that is related to a particular dataset,
by sharing content and history. In Git_ terminology, this is a *clone*
of a dataset that is configured as a *remote*.
annex
Extension to a Git_ repository, provided and managed by git-annex_ as
means to track and distribute large (and small) files without having to
inject them directly into a Git_ repository (which would slow Git
operations significantly and impair handling of such repositories in
general).
CLI
A `Command Line Interface`_. Could be used interactively by executing
commands in a `shell`_, or as a programmable API for shell scripts.
DataLad extension
A Python package, developed outside of the core DataLad codebase, which
(when installed) typically either provides additional top level `datalad`
commands and/or additional metadata extractors. Visit
`Handbook, Ch.2. DataLad’s extensions <https://handbook.datalad.org/en/latest/beyond_basics/basics-extensions.html>`_
for general information about extensions, a non-exhaustive list of extensions and instructions on how to install them, and walk-throughs of selected extensions.
.. _Git: https://git-scm.com
.. _Git-annex: http://git-annex.branchable.com
.. _`Command Line Interface`: https://en.wikipedia.org/wiki/Command-line_interface
.. _shell: https://en.wikipedia.org/wiki/Shell_(computing)
|
