# Overview: renderJS for jupyter notebook via extension
# Overview: RenderJS for Jupyter Notebook via nbextension
This repo contains two seperate things:
This repo contains two things:
1. A [jupyter frontend extension](http://jupyter-notebook.readthedocs.io/en/latest/extending/frontend_extensions.html)
also called nbextension containing the javascript and html required to load arbitrary gadgets. See folder
`renderjs_nbextension/`.
2. An [ipython extension](https://ipython.org/ipython-doc/3/config/extensions/index.html) providing necessary python the commands to initiate the renderjs and controll the loaded gadgets. This happens directly from the notebook (cells). See folder `renderjs_ipyextension/`.
2. An [ipython extension](https://ipython.org/ipython-doc/3/config/extensions/index.html) providing
necessary python commands to initiate renderjs and control the loaded gadgets.
This happens directly from the notebook (cells). See folder *renderjs_ipyextension/*.
To make this work both the nbextension and the ipython-extension need to be installed and enabled.
The extension needs both the nbextension and the ipython-extension installed and enabled
in order to function.
Right now the ipython extension works with the Python 2 Kernel (tested) and should
also work with the Python 3 Kernel (not tested).
In order to use the extension with the ERP5Kernel, the `renderjs_ipyextension`**cannot**
be used. Instead the ERP5-backend provides the functionality directly.
# Install
TODO
# Use
## Via slapos
nothing needs to be done, as the extension is shipped with the `ipython-notebook` software.
## Manual
the whole directoy */renderjs_nbextension/renderjs_nbextension* needs to be installed
and enabled as jupyter nbextension. Either use `$ jupyter nbextension [install/enable]`, for instance