Graphical interface

AbiPy provides interactive dashboards that can be used either as a standalone web apps with the bokeh server or inside jupyter notebooks. This document explains how to install the required dependencies and how to generate dashboards either with the command line interface or inside jupyter notebooks.

Important

Note that you will need a running python kernel to execute the callbacks triggerered by the GUI hence the examples given in this page are only meant to show how to build the the GUI.

Installation

Install the panel package either from pip with:

pip install panel

or with conda:

conda install panel -c conda-forge

If you want to work with JupyterLab, you will also need to install the optional PyViz JupyterLab extension:

conda install -c conda-forge jupyterlab
jupyter labextension install @pyviz/jupyterlab_pyviz

Basic Usage

The AbiPy structure and many AbiPY files provide a get_panel method that returns a dashboard that can be used inside the jupyter notebook. To enable the integration with panel inside a jupyter notebook, execute the below code:

# Import panel and activate extensions
import panel as pn
pn.extension()