index.rst

webviz documentation

webviz_package webviz_visualizations examples

Introduction

Welcome! You are now browsing the documentation for webviz - a static site generator, optionally including different kind of interactive visualizations. webviz facilitates automatic visualization using the popular open source libraries d3.js and plotly.js.

webviz creates html output such that the report can be viewed through a web browser. The site generator can be used in two different ways: using yaml and markdown, or the webviz Python API.

Using folder structure and markdown files

Webviz can be executed using

python -m webviz site_folder

where site_folder is a folder containing markdown files. See the github repository for an example. In the site_folder, there are two special files: index.md and config.yaml. index.md is the landing page for the site and config.yaml contains configuration info, such as which theme to use.

In markdown files, page elements (such as visualizations) can be added using:

{{ page_element(
     name,
     *args,
     *kwargs
 }}

name string: name of page element. Page elements are the following: :pyHtml, :pyFilteredPlotly, :pyPlotly, :pyLineChart, :pyBarChart, :pyPieChart, :pyTornadoPlot, :pyFanChart, :pyScatterPlotMatrix, :pyMap, :pyHistogram, :pyScatterPlot, :pyHeatMap

*args args: args of page elements method

**kwargs kwargs: kwargs of page elements method

API example

The example below creates several (currently empty) pages, linked together through a navigation menu. Further below you will see examples on how to add content to the different pages.

../core/examples/minimal_example.py

When the site is created by running webviz.Webviz.write_html, the output is a folder containing all the files needed for opening and running the site in a browser.

For information about how to use the webviz Python API, see the webviz_package.