remote_ikernel 0.2.9

Launch IPython/Jupyter kernels on remote systems so that they can be used with local noteboooks.

Kernels start through interactive jobs in batch queue systems (only SGE and SLURM at the moment) or through SSH connections. Once the kernel is started, SSH tunnels are created for the communication ports are so the notebook can talk to the kernel as if it was local.

Commands for managing the kernels are included.

Install with pip install remote_ikernel. Requires IPython version 3.0 or greater and pexpect. Passwordless ssh to the remote machines is also required.

# Install the module ('python setup.py install' also works)

pip install remote_ikernel

# Set up the kernels you'd like to use

remote_ikernel manage

# Add a new kernel running through GrideEngine

remote_ikernel manage --add \
    --kernel_cmd="ipython kernel -f {connection_file}" \
    --name="Python 2.7" --cpus=2 --pe=smp --interface=sge

# Add an SSH connection to a remote machine running IJulia

remote_ikernel manage --add \
    --kernel_cmd="/home/me/julia-79599ada44/bin/julia -i -F /home/me/.julia/v0.3/IJulia/src/kernel.jl {connection_file}" \
    --name="IJulia 0.3.8" --interface=ssh \
    --host=me@remote.machine --workdir='/home/me/Workdir' --language=julia

# Set up kernels for all your local virtual environments that can be run
# from a single notebook server.

remote_ikernel manage --add \
    --kernel_cmd="/home/me/Virtualenvs/dev/bin/ipython kernel -f {connection_file}" \
    --name="Python 2 (venv:dev)" --interface=local

The kernel spec files will be installed so that the new kernel appears in the drop-down list in the notebook.