Binder Documentation¶
Binder allows you to create custom computing environments that can be shared and used by many remote users. It is powered by BinderHub, which is an open-source tool that deploys the Binder service in the cloud. One-such deployment lives here, at mybinder.org, and is free to use. For more information about the mybinder.org deployment and the team that runs it, see About mybinder.org.
This documentation provides information for those who wish to use a pre-existing BinderHub deployment such as mybinder.org. If you’d like documentation on how to create and administer your own BinderHub deployment, see the BinderHub documentation, which guides you through deploying your own BinderHub.
Getting Started with Binder¶
If you’re just getting started with Binder, see the pages below…
Getting started with Binder
How-To guides and Tutorials¶
The following sections discuss some more in-depth topics on preparing and sharing your Binder repository. How-To guides are shorter, actionable patterns that accomplish something specific. Tutorials are more high-level and thorough, and often cover more conceptual topics.
Note
Binder is a research pilot, whose main goal is to understand usage patterns and workloads for future evolution and development. It is not a service that can be relied on for critical operations.
How to...
Tutorials and in-depth guides
Sample repositories and configuration¶
The following is a list of sample repositories showing off various things you can do with Binder configuration files.
Sample repositories and configuration
- Sample Binder Repositories
- Configuration Files
environment.yml
- Install a Python environmentrequirements.txt
- Install a Python environmentsetup.py
- Install Python packagesREQUIRE
- Install a Julia environmentinstall.R
- Install an R/RStudio environmentapt.txt
- Install packages with apt-getDESCRIPTION
- Install an R packagemanifest.xml
- Install StencilapostBuild
- Run code after installing the environmentstart
- Run code before the user sessions startsruntime.txt
- Specifying runtimesdefault.nix
- the nix package managerDockerfile
- Advanced environments
Finally, here is a list of interesting Binder repositories from around the web:
See the Binder Examples GitHub organization for more Binder repositories demonstrating its functionality.
The Binder Community¶
These pages cover more advanced topics in the Binder ecosystem, community
guidelines for users and developers, and information about the mybinder.org
service.
Citing Binder¶
If you publish work that uses Binder, please consider citing the Binder paper from the 2018 SciPy proceedings!
Here is a citation that you can use:
Jupyter et al., "Binder 2.0 - Reproducible, Interactive, Sharable
Environments for Science at Scale." Proceedings of the 17th Python
in Science Conference. 2018. 10.25080/Majora-4af1f417-011