jupyter

Documentation

Overview

Package jupyter implements a jupyter kernel for Neugram.

It is built directly on top of the zmtp package because the gomq project is missing zeromq features required by jupyter. However the total feature set used by jupyter is small enough that we can do it manually here, and that way avoid any C/C++ dependencies.

Specifications of interest:

https://rfc.zeromq.org/spec:23/ZMTP
http://jupyter-client.readthedocs.io/en/latest/messaging.html

Unfortunately the ZMTP spec (and the relevant linked specifications) are not clear on how they interact with TCP bind/listen/accept, so that was determined empirically.

Similarly, many details are missing from the jupyter wire format docs. When a message is broadcast on the IOPUB socket, does it include the parent_header of the session that caused it? When reporting an error, what (if any!) of the documented fields are used by jupyter? These questions were answered by poking at a running jupyter instance. Some of the answers are probably wrong.

Usage

On linux, install the "ng" binary on your PATH, and add a file named $HOME/.local/share/jupyter/kernels/neugram/kernel.json containing:

{
	"argv": [ "ng", "-jupyter", "{connection_file}" ],
	"display_name": "Neugram",
	"language": "neugram"
}

Then start a Jupyter notebook server by running "jupyter notebook".

Index

• func Run(ctx context.Context, connFile string) error

Functions

func Run

func Run(ctx context.Context, connFile string) error

Run runs a jupyter kernel, serving on the sockets described in connFile.