Run Jupyter Notebook at mybinder.org

Python Tutorials - Herong's Tutorial Examples

∟Run Jupyter Notebook at mybinder.org

This section provides a quick introduction on running Jupyter Notebook at mybinder.org, which builds the execution environment on the fly based your code dependencies.

If you want to share a Jupyter Notebook document with other, you can create Binder repository at mybinder.org. Others can open and run it interactively without installing any dependencies.

What Is Binder Repository? A Binder repository is a collection of code, data and configurations that allows the BinderHub to build an execution environment for users to run it through Web browsers.

What Is BinderHub? A Binder Repository is a platform that manages Binder repositories and execution environments.

What Is mybinder.org? mybinder.org runs an instance of BinderHub for the public to use for free.

Here are the steps to use mybinder.org for a Python script in Jupyter Notebook in a Conda environment.

1. Prepare input files for the Binder repository -

Download your Notebook *.ipynb files and data files from the Jupyter server.
Generate the environment.yml from the Conda environment using the "conda env export" command.
Login to your github.com account, and create a new project to host those input files. Currently mybinder.org can only read input files from github.com.

1. Prepare input files for the Binder repository -

Download your Notebook *.ipynb files and data files from the Jupyter server.
Generate the environment.yml from the Conda environment using the "conda env export" command.
Login to your github.com account, and create a new project to host those input files.

Note that mybinder.org can only read input files from github.com and some other repository Websites. A good example is available at github.com/binder-examples/conda.

2. Build the Binder repository -

Go to github.com/binder-examples/conda.
Enter the full URL of the new GitHub project like https://github.com/binder-examples/conda.
Click the "launch" button to build the Binder repository.
Wait for the build process to finish.
Get the output URL that represents the new Binder repository like https://mybinder.org/v2/gh/binder-examples/conda/HEAD.

3. Test the execution environment for the Binder repository -

Enter the Binder repository URL in a Web browser: https://mybinder.org/v2/gh/binder-examples/conda/HEAD.
mybinder.org starts to build an execution environment according to requirements given in the environment.yml input file.
Wait for the build process to finish.
mybinder.org redirects you to the new execution environment on a host in its execution network.
Open a Notebook *.ipynb file from your repository. It should be displayed in a Jupyter Notebook window.
Run each cell in the Notebook. The output should match your input Notebook file.

4. Share your Binder repository URL with others -

Publish the Binder repository URL: https://mybinder.org/v2/gh/binder-examples/conda/HEAD.
Any one can open the URL in a Web browser and enjoy the live Notebook for free.