A minimal Binder environment for using DataLad

This repository contains the minimal configuration for a Binder environment that can run DataLad.

This base environment repository is decoupled from content, allowing it to be maintained separately and preventing updates to content from triggering a rebuild of the Binder environment instance.

Acknowledgements

This software was developed with support from the German Federal Ministry of Education and Research (BMBF 01GQ1905), the US National Science Foundation (NSF 1912266), and the Deutsche Forschungsgemeinschaft (DFG, German Research Foundation) under grant SFB 1451 (431549029, INF project).

Usage

1. Empty environment

To use this environment as is, visit

From the menu file browser interface, select New > Terminal and explore DataLad in the resulting command-line shell.

Alternatively, create a new Python or bash notebook and populate this with your preferred code and descriptions.

2. Environment with content

To use this environment with content (such as Jupyter notebooks and/or data), first make this content available via a separate repository.

Then construct a URL from the base environment repository URL and the content repository URL, as follows:

https://mybinder.org/v2/gh/datalad/datalad-binder/main?urlpath=git-pull?repo=<url-of-your-content-repo>

This URL, when opened, will use nbgitpuller to automatically pull in content from the specified repository into the base Binder environment.

To use the base environment with separate content, visit

To use the base environment with separate content and parameters (Python), visit

To use the base environment with separate content and parameters (bash, not functional yet), visit

Configuration

The following files allow Binder to configure the base environment:

• environment.yml specifies the required tools/packages that will be installed via conda-forge
• apt.txt specifies the required tools/packages that will be installed via APT
• postBuild runs the commands to configure git, to install bash_kernel, to enable the nbgitpuller extension, and to install and enable the jupyter-notebookparams extension

These should only be updated if other packages or extensions are required for the base environment that allows DataLad to be run in Binder.