D3 Renderings of Matplotlib Graphics
Jupyter Notebook JavaScript Python
Permalink
Failed to load latest commit information.
bin script to write version.js Mar 28, 2014
doc Fix sphinx docs notebook conversion Nov 4, 2016
examples Add example for networkxd3forcelayout plugin Oct 3, 2016
icons add icons to repository Mar 17, 2014
mpld3 update version to 0.3.1.dev1 Nov 30, 2016
mplexporter @ a6bb9fe Update submodule hash Nov 2, 2016
notebooks Add missing NumPy import Jul 6, 2015
src update version to 0.3.1.dev1 Nov 30, 2016
test Fix for NaN/Inf line tests Sep 14, 2016
.gitignore TST: rework test plots for cleaner testing Apr 14, 2014
.gitmodules revert to mpld3 mplexporter May 26, 2016
.travis.yml Test with matplotlib 1.5 on Travis Nov 2, 2016
AUTHORS.md DOC: update website theme Apr 21, 2014
CONTRIBUTING.md Use CamelCase spelling for JavaScript in docs Apr 26, 2014
LICENSE Initial commit Dec 18, 2013
MANIFEST.in BUG: fix test script in manifest Apr 21, 2014
Makefile makefile: fix version script Apr 29, 2014
README.md README.md: Switch from `pypip.in` to `shields.io` as `pypip.in` is do… Jul 23, 2015
RELEASING.md update RELEASING instructions with website build Jul 23, 2015
_mpld3_setup.py added check for existing submodule source directory May 14, 2014
create_example.py Remove unused imports Oct 5, 2016
package.json Use d3 v3.5.12 Sep 2, 2016
setup.cfg add setup.cfg Feb 11, 2014
setup.py DOC: add python 3.4 to setup.py Apr 15, 2014
version.py use ast rather than re to get version Mar 28, 2014
visualize_tests.py Fix visualize_tests.py JSON not serializable Jan 14, 2016

README.md

mpld3: A D3 Viewer for Matplotlib

This is an interactive D3js-based viewer which brings matplotlib graphics to the browser. Please visit http://mpld3.github.io for documentation and examples.

You may also see the blog post, or the IPython notebook examples available in the notebooks directory of this repository.

version status downloads build status

About

mpld3 provides a custom stand-alone javascript library built on D3, which parses JSON representations of plots. The mpld3 python module provides a set of routines which parses matplotlib plots (using the mplexporter framework) and outputs the JSON description readable by mpld3.js.

Installation

mpld3 is compatible with python 2.6-2.7 and 3.3-3.4. It requires matplotlib version 1.3 and jinja2 version 2.7+.

Optionally, mpld3 can be used with IPython notebook, and requires IPython version 1.x or (preferably) version 2.0+.

This package is based on the mplexporter framework for crawling and exporting matplotlib images. mplexporter is bundled with the source distribution via git submodule.

Within the git source directory, you can download the mplexporter dependency and copy it into the mpld3 source directory using the following command:

[~]$ python setup.py submodule

The submodule command is not necessary if you are installing from a distribution rather than from the git source.

Once the submodule command has been run, you can build the package locally using

[~]$ python setup.py build

or install the package to the standard Python path using:

[~]$ python setup.py install

Or, to install to another location, use

[~]$ python setup.py install --prefix=/path/to/location/

Then make sure your PYTHONPATH environment variable points to this location.

Trying it out

The package is pure python, and very light-weight. You can take a look at the notebooks in the examples directory, or run create_example.py, which will create a set of plots and launch a browser window showing interactive views of these plots.

For a more comprehensive set of examples, see the IPython notebook examples available in the notebooks directory.

Test Plots

To explore the comparison between D3 renderings and matplotlib renderings for various plot types, run the script visualize_tests.py. This will generate an HTML page with the D3 renderings beside corresponding matplotlib renderings.

Features

Many of the core features of matplotlib are already supported. And additionally there is some extra interactivity provided via the plugin framework. The following is a non-exhausive list of features that are yet to be supported:

  • tick specification & formatting
  • some legend features
  • blended transforms, such as those required by axvlines and axhlines
  • twin axes (i.e. multiple scales on one plot) tied together

If any of these look like something you'd like to tackle, feel free to submit a pull request!