Skip to main content

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

Jupyter-Remote aims to streamline remote Jupyter usage for a range of remote configurations, from simple servers to SLURM clusters that require request forwarding to a compute node.

Installation

Set up Jupyter on the remote server.

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 to suit your needs.

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

Usage

jupyter-remote [profile] [subcommand]

Both arguments are optional.

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

jupyter remote o2 lab

Be sure to try out JupyterLab!

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

Profiles

Make a copy of jupyter-remote.cfg and name it jupyter-remote-[profile name].cfg. See example_cfgs/jupyter-remote-o2.cfg.

Note: Both the profile and subcommand option are optional. If only one is provided, Jupyter-Remote will first look for a profile with that name, and if none is found, it will use the default profile with the given subcommand.

Requirements and compatibility

  • python 2.7 or 3.6

  • pexpect.pxssh

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

  • pinentry (suggested)

Download files

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

Source Distribution

jupyter-remote-0.9.3.tar.gz (21.5 kB view details)

Uploaded Source

File details

Details for the file jupyter-remote-0.9.3.tar.gz.

File metadata

File hashes

Hashes for jupyter-remote-0.9.3.tar.gz
Algorithm Hash digest
SHA256 44772eb63bcfc9444b1250e44846ada6a53f4f123a2d363f6de43d5ecf1138ae
MD5 bddee6f41f3dec98cde5dd58e2839e5c
BLAKE2b-256 070e4638b5e7daa52bc718f955fd9d2e2f25c66b6553025a1c087bcb68a3ab69

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.9.3 This release

1 file

0.9.2

1 file

0.9.1

1 file

0.9.0

1 file

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page