jupyter-o2 0.2.6

Run Jupyter on Orchestra 2

Jupyter-O2 is a command-line tool that automatically runs Jupyter on Orchestra 2, an HPC cluster managed by the HMS Resesarch Computing group.

Installation

First, follow the O2 wiki’s procedure to set up Jupyter for your account on O2.

Next, install Jupyter-O2.

pip install jupyter-o2

Then, generate the config file.

jupyter-o2 --generate-config

Follow the printed path to jupyter-o2.cfg and edit according to its instructions, particularly the DEFAULT_USER, MODULE_LOAD_CALL, and SOURCE_JUPYTER_CALL fields.

For more info on setting up Jupyter and troubleshooting Jupyter-O2, see the jupyter-o2 tips.

Usage

jupyter-o2 [subcommand]

Examples: jupyter-o2 notebook or jupyter-o2 lab (try JupyterLab!)

If Jupyter is installed on your machine, Jupyter-O2 can also be run as a Jupyter subcommand:

jupyter o2 lab

For info on the Jupyter-O2 command-line options, use jupyter-o2 --help.

Requirements and compatibility

• python 2.7 or 3.6

• pexpect.pxssh

• POSIX: Jupyter-O2 has been tested on MacOS and Linux, while on Windows it should require Cygwin and Cygwin’s version of Python.

Optional installs

• pinentry (a command line tool used instead of getpass)