Skip to content

A JupyterLab application fork for UCL-ARC RC's instances of Open OnDemand.

License

Notifications You must be signed in to change notification settings

UCL-ARC/ood-jupyter

Repository files navigation

Batch Connect - Jupyter Notebook Server

GitHub Release GitHub License

A fork of the official example Batch Connect app that launches a Jupyter Notebook server within a batch job.

This is part of the tutorial in how to make OnDemand applications, but also covers one of the more popular applications people want to add in to OnDemand.

Prerequisites

This Batch Connect app requires the following software be installed on the compute nodes that the batch job is intended to run on (NOT the OnDemand node):

  • Jupyter Notebook 4.2.3+ (earlier versions are untested but may work for you)
  • OpenSSL 1.0.1+ (used to hash the Jupyter Notebook server password)

Install

  1. Clone the repository under one of your OnDemand's application directories, e.g. /var/www/ood/apps/sys/
  2. Customise the scripts in template to be able to start a JupyterLab server on the intended system.

The submission script details can be inherited from the cluster definition unless you need something different.

All the configuration for the JupyterLab server is handled by generating a config file in template/before.sh.erb, using info passed down from the application. Look there for details and to alter that.

The details of how JupyterLab is run are in template/script.sh.erb, including the setup of the virtualenv and any modules required.

About

A JupyterLab application fork for UCL-ARC RC's instances of Open OnDemand.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published