Skip to main content

Extension for Jupyter notebooks to connect to openBIS and download/upload datasets, inluding the notebook itself

Project description



The jupyter-openbis-extension needs at least Python 3.3 in order to run. The Jupyter notebook server starts this extension during startup and must therefore run under the same Python version. The kernel can be anything (Python 2.7, Julia, R, Perl...)

Install the extension

If you haven't done yet: download the latest jupyter-openbis-extension from pip. It will automatically install the various dependencies, e.g. Pandas and NumPy.

pip install --upgrade jupyter-openbis-extension

Register the Jupyter server extension which will communicate both with openBIS and the notebook:

jupyter serverextension enable --py jupyter-openbis-extension

Register the notebook extension, the client side of the Jupyter notebook, which will communicate with the server extension via AJAX calls:

 jupyter nbextension install --py jupyter-openbis-extension --user

If you are developing, you should consider creating a link to the JavaScript source instead:

 jupyter nbextension install --py jupyter-openbis-extension --user --symlink

Finally, activate the notebook extension.

jupyter nbextension enable jupyter-openbis-extension --user --py

Create a configuration file: ~/.jupyter/openbis-connections.yaml It should contain connection information to your server(s), for example:

    - name                : TEST local openBIS instance
      url                 : https://localhost:8443
      verify_certificates : false
      username            : username
      password            : password
    - name                : PRODUCTION openBIS instance
      url                 :
      verify_certificates : true
      username            : username
      password            : password

Now you are ready to launch!

$ jupyter notebook

Observe the terminal. It should tell you that the server(s) have been successfully connected:

$ jupyter notebook
connected to TEST local openBIS instance
connected to PRODUCTION openBIS instance


Uninstall Jupyter extension

jupyter serverextension disable --py jupyter-openbis-extension
jupyter nbextension disable --py jupyter-openbis-extension --user
jupyter nbextension uninstall --py jupyter-openbis-extension --user

This should remove the registrations in ~/.jupyter/jupyter_notebook_config.json and ~/.jupyter/nbconfig/notebook.json. The symbolic link in ~/Library/Jupyter/nbextension/ (Mac OS X) should have been removed too. If not, you can remove it manually.

Manual installation (if above should fail)

Install the Python module(s)

  • clone the project:
git clone
  • cd into the extension cd jupyter-openbis-extension
  • install the python module normally: pip install .
  • or, for development, install just a symbolic link: pip install -e .
  • this extension needs Jupyter and pyBIS 1.7.2 in order to run, so it will load / upgrade it if not yet present
  • the jupyter-openbis-extension needs at least Python 3.3 in order to run. Therefore, your Jupyter notebook server (but not the kernel!) needs to run under at least Python 3.3 too.

Register the Jupyter Notebook Server Extension (server-side, as the name suggests)

  • in the terminal, enter the following:

jupyter serverextension enable --py jupyter-openbis-extension

  • OR (1) register it manually:
  • open the file ~/.jupyter/
  • add the following:
c.NotebookApp.server_extensions = [
  • OR (2) register it in ~/.jupyter/jupyter_notebook_config.json manually, if the automatic registration fails for some reasons:
  "NotebookApp": {
    "nbserver_extensions": {
      "jupyter-openbis-extension.server": true

Register the Jupyter Notebook Extension (client-side)

Inside the folder ~/Library/Jupyter/nbextension/ (Mac OS X) create a symbolic link to the folder that contains the Java Script:

ln -s /path/to/jupyter-openbis-extension/nbextension/dialog.js jupyter-openbis-extension

In the file ~/.jupyter/nbconfig/notebook.json the JavaScript gets activated like this:

  "load_extensions": {
    "jupyter-openbis-extension/dialog": true

Check that the nbextension has been installed and activated:

$ jupyter nbextension list
Known nbextensions:
  config dir: /Users/your-username/.jupyter/nbconfig
    notebook section
      jupyter-openbis-extension/dialog  enabled 
      - Validating: OK

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for jupyter-openbis-extension, version 0.0.1
Filename, size File type Python version Upload date Hashes
Filename, size jupyter-openbis-extension-0.0.1.tar.gz (11.2 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page