Welcome! This repository contains a DataLad extension that enables DataLad to work with the Open Science Framework (OSF). Use it to share, retrieve and collaborate on DataLad datasets via the OSF.
The development of this tool started at OHBM Brainhack 2020 in June 2020, coordinated in this repository. See our documentation for more extensive information.
- Datalad and datalad-next: relies on git-annex, Git and Python. If you don’t have DataLad installed yet, please follow the instructions here.
- Account on the Open Science Framework (OSF)
# create and enter a new virtual environment (optional)
$ virtualenv --python=python3 ~/env/dl-osf
$ . ~/env/dl-osf/bin/activate
# install from PyPi
$ pip install datalad-osf
Afterwards, configure DataLad to load the datalad-next extension:
git config --global --add datalad.extensions.load next
See our documentation for more info on how to use this tool and a tutorial on major use cases.
You are very welcome to help out developing this tool further. You can contribute by:
- Creating an issue for bugs or tips for further development
- Making a pull request for any changes suggested by yourself
- Testing out the software and communicating your feedback to us
Please see our contributing guidelines for more information.
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!
This DataLad extension was developed with support from the German Federal Ministry of Education and Research (BMBF 01GQ1905), and the US National Science Foundation (NSF 1912266).