README.md 31 KB

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

The DataLad handbook :orange_book:

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

🐛 🖋
tmheunis
tmheunis

🐛 📓

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