A tutorial for widgets

The Jupyter Widget Ecosystem

Tutorial, SciPy 2020

https://github.com/jupyter-widgets/tutorial

Installation

The code in the tutorial has been written using Python 3; many of the dependencies may not be available for Python 2.7.

We strongly recommend using the Anaconda Python distribution. You can install either the full anaconda distribution (very extensive, but large) or miniconda (much smaller, only essential packages).

Almost all of the examples will work in either the regular Jupyter notebook or in JupyterLab. The instructions below assume you will be using JupyterLab.

We will spend a few minutes at the beginning of the tutorial pointing out some of the features of JupyterLab from the perspective of people already familiar with Jupyter notebooks.

There are also download instructions below for installation using pip, which should work with any Python distribution.

Download this repository

You can do this with either git clone https://github.com/jupyter-widgets/tutorial.git at the command line or by downloading this repostiory as a Zip file.

conda installation instructions

The steps below will get you a working environment.

conda env create -f environment.yml

conda activate widgets-tutorial

# Create a kernel for this environment
ipython kernel install --name widgets-tutorial --display-name widgets-tutorial --sys-prefix

Windows users

The installation instructions were tested on an up-to-date version of Windows 10 Professional. If you encounter any issues on Windows please open an issue or contact us through slack.

pip installation instructions

If you are not using the anaconda python distribution, please use the instructions below.

pip install -r requirements.txt

# Create a kernel for this environment
ipython kernel install --name widgets-tutorial --display-name widgets-tutorial --sys-prefix

Install JupyterLab extensions

In order to install the JupyterLab extensions, you need nodejs to be installed. If you use conda it should have been already installed for you when you created your environment.

If you do not use conda, see https://nodejs.org/en/download/ or https://nodejs.org/en/download/package-manager/ for download and installation instructions.

Now you can install the JupyterLab extensions:

# This may take several minutes
jupyter labextension install @jupyter-widgets/jupyterlab-manager @jupyter-widgets/jupyterlab-sidecar bqplot jupyter-threejs jupyter-leaflet@0.12.6 ipysheet ipytree ipycanvas jupyter-matplotlib jupyter-vuetify ipyvolume

Check your installation

To check your installation, please download the script install_check.py and run it:

python install_check.py

Tutorial materials

To get the tutorial materials, clone this repository. We anticipate making changes to the tutorial content through the end of July 8, 2020.

To update your copy of the tutorial materials, navigate in a terminal to folder these materials are in then run git pull. An alternative is to download the repository again as a zip file.

Using binder

Many of the materials work without modification on mybinder.org without needing to install anything on your computer. However, this is not the recommended way to do the tutorial.

Go to mybinder.org to run the tutorial online.

Any ipywidgets or custom widgets library question?

Please join us on the Gitter channel: https://gitter.im/jupyter-widgets/Lobby

Running into trouble?

Please let us know! You can open an issue on this repository by clicking “Issues” under the repo name on GitHub, then the “New Issue” button in the upper right.