https://github.com/datalad/datalad-binder
A minimal Binder environment for using DataLad
https://github.com/datalad/datalad-binder
Last synced: 4 months ago
JSON representation
A minimal Binder environment for using DataLad
- Host: GitHub
- URL: https://github.com/datalad/datalad-binder
- Owner: datalad
- License: mit
- Created: 2021-09-07T13:07:27.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-09-05T08:44:02.000Z (almost 3 years ago)
- Last Synced: 2025-09-11T10:49:54.757Z (9 months ago)
- Language: Python
- Homepage:
- Size: 18.6 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# A minimal Binder environment for using DataLad
This repository contains the minimal configuration for a [Binder](https://mybinder.org/)
environment that can run [DataLad](https://www.datalad.org/).
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](https://gepris.dfg.de/gepris/projekt/431549029),
INF project).
## Usage
### 1. Empty environment
To use this environment *as is*, visit [](https://mybinder.org/v2/gh/datalad/datalad-binder/HEAD)
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=
```
This URL, when opened, will use [nbgitpuller](https://github.com/jupyterhub/nbgitpuller) to automatically pull in content from the specified
repository into the base Binder environment.
To use the base environment with separate content, visit [](https://mybinder.org/v2/gh/datalad/datalad-binder/HEAD?urlpath=git-pull?repo=https://github.com/jsheunis/datalad-notebooks)
To use the base environment with separate content **and parameters (Python)**, visit [](https://mybinder.org/v2/gh/datalad/datalad-binder/HEAD?urlpath=git-pull%3Frepo%3Dhttps%253A%252F%252Fgithub.com%252Fjsheunis%252Fdatalad-notebooks%26urlpath%3Dnotebooks%252Fdatalad-notebooks%252Fdownload_data_with_datalad_python.ipynb%3Frepourl%3D%22https://github.com/psychoinformatics-de/paper-remodnav.git%22%26autorun%3Dtrue)
To use the base environment with separate content **and parameters (bash, not functional yet)**, visit [](https://mybinder.org/v2/gh/datalad/datalad-binder/HEAD?urlpath=git-pull%3Frepo%3Dhttps%253A%252F%252Fgithub.com%252Fjsheunis%252Fdatalad-notebooks%26urlpath%3Dnotebooks%252Fdatalad-notebooks%252Fdownload_data_with_datalad_bash.ipynb%3Frepourl%3D%22https://github.com/psychoinformatics-de/paper-remodnav.git%22%26autorun%3Dtrue)
## 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](https://conda-forge.org/)
- `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.