Sources for the DataLad Handbook

4,199 commits 1 branch 0 tags 13 MiB

Python 94.9%
Makefile 4%
Shell 1.1%

Find a file

Adina Wagner dc6f7e8491 add Aaron as contributor		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

README.md

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:

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.
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):

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}
🐛 📓

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!