Jupyter notebooks are web applications that combine text, code and output (https://jupyter.org/). Jupyter supports over 40 programming languages.
Jupyter notebooks can be used to analyze data stored in openBIS.
It is possible to connect to a JupyterHub server and launch Jupyter notebooks directly from the openBIS interface. This feature is not available by default, but needs to be enabled and configured by a system admin. JupyterHub docker containers are available from our download page: https://wiki-bsse.ethz.ch/display/bis/openBIS+Download+Page. Further documentation can be found here: https://wiki-bsse.ethz.ch/display/openBISDoc1906/JupyterHub+for+openBIS.
Jupyter notebooks can be opened at every level of the openBIS hierarchy (Space, Project, Experiment/Collection, Object, Dataset) by clicking the Jupyter icon:
It is also possible to launch a Jupyter notebook from the main menu, under Utilities, or open a workspace on the JupyterHub server.
To create a notebook, it is necessary to enter:
- The dataset(s) needed for the analysis
- The owner of the Jupyter notebook. Jupyter notebooks are saved back to openBIS as datasets, and these belong either to an Experiment/Collection or to an Object. The owner is the Experiment/Collection or Object where the notebook should be stored.
- The directory name. This is the name of the folder that will be created on the JupyterHub server.
- Notebook name. This is the name of the Jupyter notebook
Overview of Jupyter notebook opened from openBIS.
The Jupyter notebook opened from the openBIS interface contains some pre-filled cells. All cells need to be run. The information of two cells should be modified: Name of the dataset where the notebook will be stored and Notes (in red below).
Your script should be written in the section named “Process your data here”, that contains one empty cell (see below).
After the analysis is done, the notebook can be saved back to openBIS, by running the last few cells which contain the information about where the notebook will be stored (as shown below).
A Jupyter extension plugin for openBIS is also available: https://pypi.org/project/jupyter-openbis-extension/ .