Skip to content

Latest commit

 

History

History
49 lines (32 loc) · 1.84 KB

jupyter_kernel.markdown

File metadata and controls

49 lines (32 loc) · 1.84 KB
Raw

TutorialD Jupyter Kernel for Project:M36

Introduction

The Jupyter Notebook is web-based tool for experimenting with various languages. Project:M36 offers a Jupyter kernel for the TutorialD interpreter.

The kernel automatically starts and stops its own websocket-server-based database and offers no filesystem persistence, which is similar to other jupyter kernels.

Installation

To install the tutd kernel:

  • install the itutd module into your jupyter virtual environment:
$ cd project-m36/jupyter/itutd
$ pip install .

  • install kernel.json:

    $ mkdir ~/Library/Jupyter/kernels/itutd && cp project-m36/jupyter/kernel.json ~/Library/Jupyter/kernels/itutd (macOS)

    $ mkdir ~/.local/share/jupyter/kernels/tutd && cp project-m36/jupyter/kernel.json ~/.local/share/jupyter/kernels/tutd (Linux)

    $ mkdir %APPDATA%\jupyter\kernels\tutd && copy project-m36\jupyter\kernel.json %APPDATA%\jupyter\kernels\tutd (Windows)

  • check that the kernel is detected:

$ jupyter kernelspec list
Available kernels:
  python2    ...
  tutd       ...
  • add project-m36-server to PATH environment variable
$ export PATH=$PATH:<path/to/project-m36-websocket-server>
$ which project-m36-websocket-server
/path/to/project-m36-websocket-server

From within this python virtual environment, you can now start jupyter with TutorialD support.

Usage

With the kernel installed, run jupyter notebook for the web-based interface and click "New" at the top right of the page. The TutorialD kernel should be in the list.

Once a new TutorialD notebook is opened, the interpreter is identical to the tutd command line interpreter and accepts the same commands. If you are new to Project:M36-flavored TutorialD, please read the tutorial.