vidartf / phoila

BSD 3-Clause "New" or "Revised" License
9 stars 5 forks source link

phoila

Build Status codecov

A Phosphor wrapper for Voila, hence the name Pho(sphor) + (V)oila.

https://github.com/phosphorjs/phosphor/

https://github.com/Quantstack/voila

Screencast

Installation

Install using pip:

pip install phoila

Add any lab extensions you need to phoila:

phoila install <lab-extension name> [<lab-extension name> ...]

(if you don't need any extensions, make sure to run phoila build instead)

Then run it:

phoila

Helpful config options

Since all kernels are one-to-one per dashboard, without any magic to automatically shut down kernels once the dashboard is closed, it can be helpful to configure automatic culling, by configuring MappingKernelManager.cull_idle_timeout to a value greater than 0. This can either be done on invocation --MappingKernelManager.cull_idle_timeout=300 or in a config file (phoila --generate-config).

Components

Phoila consists of the following parts: