The sources of the DataLad Handbook https://handbook.datalad.org
  • Python 94.9%
  • Makefile 4%
  • Shell 1.1%
Find a file
2026-02-05 15:14:00 +01:00
.github let codespell ignore commun (from nature communications) 2025-06-04 14:35:07 +02:00
artwork Transition handbook links to https 2023-11-01 13:57:35 +01:00
dataladhandbook_support make glossary entry on paths also work for windows 2023-10-27 16:26:13 +02:00
docs Fix git-annex installation command in documentation 2026-02-03 10:23:21 +01:00
tools TMP: test singularity installation from core 2025-06-26 17:40:46 +02:00
.all-contributorsrc docs: update .all-contributorsrc [skip ci] 2026-02-05 07:10:04 +00:00
.appveyor.yml bump build image version 2025-06-26 17:46:24 +02:00
.gitattributes Modernize versioning setup. 2019-09-11 08:45:40 +02:00
.gitignore Ignore venv directory 2025-01-03 17:36:45 +01:00
.gitmodules Link artwork dataset 2019-08-25 14:06:51 +02:00
.readthedocs.yml Declare / update RTD build environment 2023-05-10 18:40:40 +02:00
.travis.yml Consolidate link URLs throughout the handbook 2023-08-07 16:08:44 +02:00
.zenodo.json add Aaron as contributor 2026-02-05 15:14:00 +01:00
CHANGELOG.md Typo: usecase -> use case 2023-11-02 16:18:20 +01:00
CODE_OF_CONDUCT.md fix typo 2024-07-01 16:22:00 +02:00
CONTRIBUTORS.md Consolidate link URLs throughout the handbook 2023-08-07 16:08:44 +02:00
LICENSE declare CC-BY-SA 2019-06-19 15:03:09 +02:00
Makefile add a rule to clean challenges in the Makefile 2025-06-06 08:38:04 +02:00
MANIFEST.in Modernize versioning setup. 2019-09-11 08:45:40 +02:00
pyproject.toml Propagate the desired skips into the config 2023-08-11 13:04:19 -04:00
README.md docs: update README.md [skip ci] 2026-02-05 07:10:03 +00:00
requirements-devel.txt UV 2025-06-09 08:05:01 +02:00
requirements.txt Remove (duplicate) editable install requirement for handbook_support 2025-06-11 16:47:46 +02:00
setup.cfg Revert even more setup.cfg setup to get readthedocs to install deps 2019-09-11 10:01:19 +02:00
setup.py Add alabaster theme to setup.py with minimal version of 0.7.11 for show_relbar 2020-02-12 10:14:41 -05:00
versioneer.py re-run -> rerun 2023-11-06 07:37:23 +01:00

Build status Monthly link check Documentation Status DOI made-with-datalad

All Contributors

The DataLad handbook 📙

This is a living resource on why and - more importantly - how to use DataLad. The rendered version is here: https://handbook.datalad.org, and is currently under initial development.

The handbook is a practical, hands-on crashcourse to learn and experience DataLad. You do not need to be a programmer, computer scientist, or Linux-crank. If you have never touched your computer's shell before, you will be fine. Regardless of your background and personal use cases for DataLad, the handbook will show you the principles of DataLad, and from chapter 1 onwards you will be using them.

Find more general information about the idea behind the handbook in the poster presented at the 2020 OHBM or dive straight into your DataLad adventure.

Contributing

Contributions in any form - pull requests, issues, content requests/ideas, ... are always welcome. If you are using the handbook and find that something does not work, please let us know. Likewise, if you are using DataLad for your individual project, consider contributing by telling us about your use-case. You can find out more on how to contribute here, and a list of all contributors so far below, in CONTRIBUTORS.md, and in .zenodo.json.

Notes for Instructors

The book is the basis for workshops and lectures on DataLad and data management. The handbook's course repository among other things contains live casts from the code examples in this book and slides. It is constantly growing, and everyone is free to use the material under the license terms below. Contributions and feedback are very welcome.

License

CC-BY-SA: You are free to

  • share - copy and redistribute the material in any medium or format
  • adapt - remix, transform, and build upon the material for any purpose, even commercially

under the following terms:

  1. Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.

  2. ShareAlike — If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.

Contributors

Thanks goes to these wonderful people (emoji key):

Adina S. Wagner
Adina S. Wagner

💻 🖋 📖 🎨 🤔 🚇 🚧 📆 👀 📓 📢 ⚠️ 🐛 💡 💬
Laura Waite
Laura Waite

🤔 🚧 👀 📢 💬 🖋
Michael Hanke
Michael Hanke

💬 🐛 💻 🖋 📖 🎨 💡 🤔 🚇 🚧 🔌 📆 👀 🔧 ⚠️ 📢 📓
Kyle Meyer
Kyle Meyer

🐛 👀 💬 🖋 🤔
Marisa Heckner
Marisa Heckner

🤔 📓 🐛 🖋
Benjamin Poldrack
Benjamin Poldrack

💬 🤔 💡
Yaroslav Halchenko
Yaroslav Halchenko

👀 🖋 🤔 🐛
Chris Markiewicz
Chris Markiewicz

🐛
Pattarawat Chormai
Pattarawat Chormai

🐛 💻
Lisa N. Mochalski
Lisa N. Mochalski

🐛 🖋 💡 🤔
Lisa Wiersch
Lisa Wiersch

🐛
Jean-Baptiste Poline
Jean-Baptiste Poline

🖋
Nevena Kraljevic
Nevena Kraljevic

📓
Alex Waite
Alex Waite

👀 🐛 🤔
Lya K. Paas
Lya K. Paas

🐛 💻
Niels Reuter
Niels Reuter

🖋
Peter Vavra
Peter Vavra

🤔 📓
Tobias Kadelka
Tobias Kadelka

📓
Peer Herholz
Peer Herholz

🤔
Alexandre Hutton
Alexandre Hutton

🖋 🐛
Sarah Oliveira
Sarah Oliveira

👀 🤔
Dorian Pustina
Dorian Pustina

🤔
Hamzah Hamid Baagil
Hamzah Hamid Baagil

📓 🐛
Tristan Glatard
Tristan Glatard

🐛 🖋
Giulia Ippoliti
Giulia Ippoliti

🖋 💡
Christian Mönch
Christian Mönch

🖋
Togaru Surya Teja
Togaru Surya Teja

🖋
Dorien Huijser
Dorien Huijser

🐛 📓
Ariel Rokem
Ariel Rokem

🐛
Remi Gau
Remi Gau

🐛 🤔 🚧 👀 🚇 💻 🎨
Judith Bomba
Judith Bomba

🐛
Konrad Hinsen
Konrad Hinsen

🐛
Wu Jianxiao
Wu Jianxiao

🐛
Małgorzata Wierzba
Małgorzata Wierzba

📓 👀
Stefan Appelhoff
Stefan Appelhoff

🚇 🔧 🐛
Michael Joseph
Michael Joseph

🤔 🖋 🐛
Tamara Cook
Tamara Cook

👀 🚇
Stephan Heunis
Stephan Heunis

🐛 🚧 🖋 💡 👀
Joerg Stadler
Joerg Stadler

🐛
Sin Kim
Sin Kim

🐛 🖋 👀
Oscar Esteban
Oscar Esteban

🐛
Michał Szczepanik
Michał Szczepanik

👀 🐛 🖋
eort
eort

🐛
Myrskyta
Myrskyta

🐛
Thomas Guiot
Thomas Guiot

🐛
jhpb7
jhpb7

🐛
Ikko Ashimine
Ikko Ashimine

🐛
Arshitha Basavaraj
Arshitha Basavaraj

🖋 🐛 🚧
Anthony J Veltri
Anthony J Veltri

📓
Isil Bilgin
Isil Bilgin

🐛 🚧
Julian Kosciessa
Julian Kosciessa

🖋
Isaac To
Isaac To

🚧 🖋 🐛
Austin Macdonald
Austin Macdonald

🐛
Christopher S. Hall
Christopher S. Hall

🐛
jcf2
jcf2

🐛
Julien Colomb
Julien Colomb

🖋
Danny Garside
Danny Garside

🐛 🚧
Justus Kuhlmann
Justus Kuhlmann

🖋
melanieganz
melanieganz

🐛
Damien François
Damien François

🐛 🖋
Tosca Heunis
Tosca Heunis

🐛 📓
Jeremy Magland
Jeremy Magland

🐛
Matthias Riße
Matthias Riße

🐛
David Nicholson
David Nicholson

🐛 🖋
Mika Pflüger
Mika Pflüger

🚧 🖋
Malik
Malik

🐛 👀 💻
Seyed (Yahya) Shirazi
Seyed (Yahya) Shirazi

🖋
Andreas Knüpfer
Andreas Knüpfer

🖋
Aaron Ponti
Aaron Ponti

🐛 🖋

This project follows the all-contributors specification. Contributions of any kind welcome!