Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Tools for Matplotlib
Python
tree: c32de922e3

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
doc
examples
mpltools
.gitignore
LICENSE
Makefile
README.rst
requirements.txt
setup.py

README.rst

Tools for Matplotlib

As the name implies, mpltools provides tools for working with matplotlib. For the most part, these tools are only loosely-connected in functionality, so the best way to get started is to look at the example gallery.

Styles

This package got its start by implementing plotting "styles"---essentially stylesheets that are similar to matplotlibrc files. Unfortunately, the syntax for an mplstyle file is slightly different than matplotlibrc files because we use ConfigObj to parse them.

Style names should be specified as sections in a "mplstyle" file. A simple mplstyle file would look like:

[style1]

text.fontsize = 12
figure.dpi = 150

[style2]

text.fontsize = 10
font.family = 'serif'

mpltools searches the current working directory and your home directory for mplstyle files. To use a style, you just add:

>>> from mpltools import style
>>> style.use('style1')

There are a number of pre-defined styles located in mpltools/style/. To list all available styles, use:

>>> print style.available

Documentation

For more details about use and installation, see the mpltools documentation.

Requirements

Installation from source

mpltools may be installed globally using:

$ git clone git@github.com:tonysyu/mpltools.git
$ cd mpltools
$ python setup.py install

or locally using:

$ python setup.py install --prefix=${HOME}

If you prefer, you can use it without installing, by simply adding this path to your PYTHONPATH variable and compiling the extensions:

$ python setup.py build_ext -i

Licence

New BSD (a.k.a. Modified BSD). See LICENSE in this directory for details.

Something went wrong with that request. Please try again.