git.iko.soy/project-m36
on master help sign in
Add notes regarding the websocket server being started from the jupyter kernel
4c6767eAgentM
docs/jupyter_kernel.markdown+12
compare with master
unifiedsplit
@@ -4,6 +4,8 @@
4
4
5[The Jupyter Notebook](https://jupyter-notebook.readthedocs.io/en/stable/notebook.html) is web-based tool for experimenting with various languages. Project:M36 offers a Jupyter kernel for the TutorialD interpreter.
5[The Jupyter Notebook](https://jupyter-notebook.readthedocs.io/en/stable/notebook.html) is web-based tool for experimenting with various languages. Project:M36 offers a Jupyter kernel for the TutorialD interpreter.
6
6
7+The kernel automatically starts and stops its own websocket-server-based database and offers no filesystem persistence, which is similar to other jupyter kernels.
8+
7## Installation
9## Installation
8
10
9To install the `tutd` kernel:
11To install the `tutd` kernel:
@@ -30,6 +32,16 @@ Available kernels:
30 tutd ...
32 tutd ...
31```
33```
32
34
35+* add `project-m36-server` to `PATH` environment variable
36+
37+```
38+$ export PATH=$PATH:<path/to/project-m36-websocket-server>
39+$ which project-m36-websocket-server
40+/path/to/project-m36-websocket-server
41+```
42+
43+From within this python virtual environment, you can now start jupyter with TutorialD support.
44+
33## Usage
45## Usage
34
46
35With 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.
47With 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.