146 lines
3.8 KiB
ReStructuredText
146 lines
3.8 KiB
ReStructuredText
:orphan:
|
|
|
|
.. meta::
|
|
:description: The home of the DataLad handbook
|
|
|
|
.. image:: artwork/src/img/datalad-animated.gif
|
|
:scale: 100%
|
|
:alt: Animated DataLad logo
|
|
|
|
============
|
|
The Handbook
|
|
============
|
|
|
|
**Welcome!**
|
|
|
|
This handbook is a living resource about why and -- more importantly -- *how* to
|
|
use DataLad. It aims to provide novices and advanced users of all backgrounds
|
|
with both the basics of DataLad and start-to-end use cases of specific
|
|
applications. If you want to get hands-on experience and learn DataLad, the *Basics*
|
|
part of this book will teach you. If you want to know what is possible, the
|
|
*use cases* will show you. And if you want to help others to get started with DataLad,
|
|
the `companion repository <https://github.com/datalad-handbook/course>`_ provides
|
|
:ref:`free and open source teaching material <teach>` tailored to the handbook.
|
|
|
|
Before you read on, please note that this version of the handbook is based on **at least** DataLad version **0.17**, and the higher your version of DataLad is, the better.
|
|
The section :ref:`install` will set you up with what you need if you currently do not have DataLad 0.17 or higher installed.
|
|
|
|
.. importantnote:: Did you know ...
|
|
|
|
... that you can also easily get a **physical copy** of this book?
|
|
|
|
.. image:: perma/book-intro-v1/intro-v1-cover.jpg
|
|
:width: 50%
|
|
:align: center
|
|
:target: https://handbook.datalad.org/en/latest/perma/book-intro-v1.html
|
|
|
|
For example from a book store near you (ISBN 979-8857037973), or from any amazon site (e.g., `US <https://www.amazon.com/dp/B0CPDB4YMY>`_ or `EU <https://amzn.eu/d/e6A7nAO>`_).
|
|
|
|
|
|
|
|
If you're new here, please start the handbook :ref:`here <philo>`.
|
|
Alternatively, try to identify with one of several user-types in this
|
|
:ref:`user specific guide to the handbook <usertypes>`.
|
|
|
|
.. importantnote:: The handbook is a collaborative resource
|
|
|
|
If you would be willing to provide feedback on its contents, please
|
|
`get in touch <https://github.com/datalad-handbook/book/issues/new>`_.
|
|
|
|
|
|
.. image:: artwork/src/enter.svg
|
|
:width: 60%
|
|
:align: center
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: What this is all about
|
|
|
|
intro/intro
|
|
|
|
.. image:: artwork/src/basics.svg
|
|
:width: 60%
|
|
:align: center
|
|
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
:caption: The fundamentals of DataLad
|
|
|
|
basics/intro
|
|
|
|
.. image:: artwork/src/advanced.svg
|
|
:width: 60%
|
|
:align: center
|
|
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
:caption: Beyond the Basics
|
|
|
|
beyond_basics/intro.rst
|
|
|
|
.. image:: artwork/src/usecases.svg
|
|
:width: 60%
|
|
:align: center
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Hands-on real-world applications with step-by-step recipes
|
|
|
|
usecases/intro
|
|
|
|
########
|
|
Appendix
|
|
########
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Further information and references
|
|
|
|
glossary
|
|
basics/101-180-FAQ
|
|
basics/101-136-cheatsheet
|
|
contributing
|
|
challenges/intro
|
|
teaching
|
|
acknowledgements
|
|
licenses
|
|
intro/user_types
|
|
OHBMposter
|
|
usecases/openneuro
|
|
intro/windows
|
|
intro/filenaming
|
|
|
|
########################
|
|
Code lists from chapters
|
|
########################
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Easy access to copy-paste snippets for workshops
|
|
|
|
code_from_chapters/intro
|
|
code_from_chapters/01_dataset_basics_code
|
|
code_from_chapters/02_reproducible_execution_code
|
|
code_from_chapters/10_yoda_code
|
|
code_from_chapters/OHBM
|
|
code_from_chapters/OHBM_OSR.rst
|
|
code_from_chapters/usecase_ml_code
|
|
code_from_chapters/MPI_code
|
|
code_from_chapters/DLBasicsMPI
|
|
code_from_chapters/ABCD
|
|
code_from_chapters/yale
|
|
code_from_chapters/dgpa
|
|
code_from_chapters/neurohackademy
|
|
code_from_chapters/osoh.rst
|
|
..
|
|
stuff that we do not need or show at the moment
|
|
|
|
.. only:: adminmode
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
usecases/datasets
|
|
topic_index
|
|
r
|
|
perma/book-intro-v1
|