DisJotter 1.0.5

DisJotter allows the user to interactively create a Docker image from a Jupyter Notebook.

Note: DisJotter is not currently being maintained. It has been forked as 'FAIR-Cells', which is available at:

https://github.com/QCDIS/FAIRCells and https://pypi.org/project/FAIR-Cells/

DisJotter

DisJotter is a Jupyter Notebook extension that allows the user to interactively create a Docker image from a Jupyter Notebook. Our tool can be used to generate Docker images from single cells of a Jupyter Notebook. The generated image will run a web service that will output the specified cell. This includes image outputs like plots. Code introspection for Python enables the services to change cell output at service run-time.

Among other things, DisJotter is useful for reusing notebook components in workflows that support web services.

... More information to follow ...

Installation

DisJotter can be downloaded using pip. It then needs to be enabled using three Jupyter commands. Docker is required for the extension to have any effect.

$ [sudo] pip install disjotter
$ jupyter serverextension enable --py disjotter
$ jupyter nbextension install --py disjotter
$ jupyter nbextension enable --py disjotter

Development

To keep your system clean it is recommended to develop using Docker. The following command will run a Jupyter Notebook server with DisJotter enabled at http://localhost:8888. Autoreload is enabled for Python files, you will need to reload your browser to see changes in the front-end.

$ docker-compose up --build main

To test the helper server that runs inside of the container run the following command. This uses a dummy notebook that can be found in docker/helper_dummy. The notebook will be available at http://localhost:10000

$ docker-compose up --build helper