InsightBoard

A dashboard to upload and manage data and generate reports.

Documentation: ReadTheDocs

Installation

First, ensure you have a compatible version of Python 3 installed on your computer, then install InsightBoard using your favourite package manager. Modern Python distributions come bundled with pip, so this would be:

pip3 install InsightBoard

You will also want to install ADTL (Another Data Transform Language) to make full use of the parsers, including those supplied with the sample project:

pip3 install "adtl[parquet] @ git+https://github.com/globaldothealth/adtl"

To launch the dashboard, simply type InsightBoard from the command line. The dashboard should open in your default web browser (http://localhost:8050/). If the command is not found, you can also launch the dashboard by typing python3 -m InsightBoard.

Upgrading

To upgrade to the latest version of InsightBoard, run:

pip3 install --upgrade InsightBoard

Getting started

By default InsightBoard will create a folder called InsightBoard/projects in your home directory. This is where all your projects will be stored (you can change this location in the Settings panel of the dashboard).

We recommend that you store each project in a separate (version controlled) git repository within the projects folder. This will allow you to easily share your projects with others and keep track of any changes.

For example, to set up the sample_project in the InsightBoard/projects folder, you can run the following commands from the command line (note that this requires you to have a working github account):

cd ~/InsightBoard/projects
git clone git@github.com:globaldothealth/InsightBoard-SampleProject.git sample_project

If you now launch InsightBoard it will start with the sample_project available from the projects dropdown list (in the upper-left of the screen). Usage details, and instructions on how to create new projects, are provided in the accompanying documentation.

Developers

See the development pages for more information.