jupyter-remote 0.9.0

Run Jupyter on a remote server

Jupyter-Remote is a command-line tool that automatically runs Jupyter on a remote server. It is derived from Jupyter-O2.

Installation

Set up Jupyter on the remote server. If running on O2, follow the O2 wiki’s procedure.

Next, install Jupyter-Remote.

pip install jupyter-remote

Then, generate the config file.

jupyter-remote --generate-config

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

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

Usage

jupyter-remote [subcommand]

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

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

jupyter remote lab

For info on the Jupyter-Remote command-line options, use jupyter-remote --help.

Requirements and compatibility

• python 2.7 or 3.6

• pexpect.pxssh

• POSIX: Jupyter-Remote has been tested on MacOS. It may work on Linux, and on Windows it will require Cygwin and Cygwin’s version of Python.

Optional installs

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