| 1 |
DataLad |---| data management and publication multitool |
| 2 |
******************************************************* |
| 3 |
|
| 4 |
Welcome to DataLad's **technical documentation**. Information here is targeting |
| 5 |
software developers and is focused on the Python API and :term:`CLI`, as well |
| 6 |
as software design, employed technologies, and key features. Comprehensive |
| 7 |
**user documentation** with information on installation, basic operation, |
| 8 |
support, and (advanced) use case descriptions is available in the `DataLad |
| 9 |
handbook <http://handbook.datalad.org>`_. |
| 10 |
|
| 11 |
Content |
| 12 |
^^^^^^^ |
| 13 |
|
| 14 |
.. toctree:: |
| 15 |
:maxdepth: 1 |
| 16 |
|
| 17 |
changelog |
| 18 |
acknowledgements |
| 19 |
publications |
| 20 |
|
| 21 |
Concepts and technologies |
| 22 |
========================= |
| 23 |
|
| 24 |
.. toctree:: |
| 25 |
:maxdepth: 2 |
| 26 |
|
| 27 |
background |
| 28 |
related |
| 29 |
basics |
| 30 |
credentials |
| 31 |
customization |
| 32 |
design/index |
| 33 |
glossary |
| 34 |
|
| 35 |
Commands and API |
| 36 |
================ |
| 37 |
|
| 38 |
.. toctree:: |
| 39 |
:maxdepth: 2 |
| 40 |
|
| 41 |
cmdline |
| 42 |
modref |
| 43 |
config |
| 44 |
|
| 45 |
Extension packages |
| 46 |
================== |
| 47 |
|
| 48 |
DataLad can be customized and additional functionality can be integrated via |
| 49 |
extensions. Each extension provides its own documentation: |
| 50 |
|
| 51 |
- `Crawling web resources and automated data distributions <http://docs.datalad.org/projects/crawler>`_ |
| 52 |
- `Neuroimaging data and workflows <http://docs.datalad.org/projects/neuroimaging>`_ |
| 53 |
- `Containerized computational environments <http://docs.datalad.org/projects/container>`_ |
| 54 |
- `Advanced metadata tooling with JSON-LD reporting and additional metadata extractors <http://docs.datalad.org/projects/metalad>`_ |
| 55 |
- `Staged additions, performance and user experience improvements for DataLad <http://docs.datalad.org/projects/next>`_ |
| 56 |
- `Resources for working with the UKBiobank as a DataLad dataset <http://docs.datalad.org/projects/ukbiobank>`_ |
| 57 |
- `Deposit and retrieve DataLad datasets via the Open Science Framework <http://docs.datalad.org/projects/osf>`_ |
| 58 |
- `Functionality that has been phased out of the core package <http://docs.datalad.org/projects/deprecated>`_ |
| 59 |
- `Special interest functionality or drafts of future additions to DataLad proper <http://docs.datalad.org/projects/mihextras>`_ |
| 60 |
|
| 61 |
Indices and tables |
| 62 |
================== |
| 63 |
|
| 64 |
* :ref:`genindex` |
| 65 |
* :ref:`modindex` |
| 66 |
* :ref:`search` |
| 67 |
|
| 68 |
.. |---| unicode:: U+02014 .. em dash |