publib

KO | EN

gitlite — search

#javascript #nodejs #swift #python #ios #chrome #macos #aws #vue #webpack #android #opengl

★ 44 Open GitHub ↗

Produce publication-level quality images on top of Matplotlib

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![PyPI version](https://badge.fury.io/py/publib.svg)](https://badge.fury.io/py/publib)
[![Tests](https://img.shields.io/travis/erwanp/publib.svg)](https://travis-ci.org/erwanp/publib)
[![Code coverage](https://codecov.io/gh/erwanp/publib/branch/master/graph/badge.svg)](https://codecov.io/gh/erwanp/publib)

# Publib

## Description

Produce publication-level quality images on top of Matplotlib, with a 
simple call to a couple functions at the start and end of your script.

[Project GitHub page](https://github.com/erwanp/publib)

For similar librairies, see the [References section](https://github.com/erwanp/publib#references).

## Install

```
pip install publib
```

## Use

At the beginning of the script, call:

``` {.sourceCode .python}
set_style()
```

After each new axe is plotted, call:

``` {.sourceCode .python}
fix_style()
```

Note that importing publib will already load the basic style.

A few more styles (`'poster'`, `'article'`, etc.) can be selected with the
function `set_style()`

Because some matplotlib parameters cannot be changed before the lines
are plotted, they are called through the function `fix_style()` which:

-   changes the minor ticks

-   remove the spines

-   turn the legend draggable by default

## Examples

``` {.sourceCode .python}
import numpy as np
import matplotlib.pyplot as plt
import matplotlib as mpl
```

A default Matplotlib plot:

``` {.sourceCode .python}
mpl.rcdefaults()

x = np.linspace(0,5,250)
y = np.cos(x)**2+np.random.normal(scale=0.5,size=len(x))
yav = np.cos(x)**2
plt.figure()
ax = plt.subplot()
ax.plot(x,y,'o',label='normal distribution')
ax.plot(x,yav,zorder=-1,label='average')
plt.xlabel(r'$x$')
plt.ylabel(r'$\cos^2 x$+noise')
plt.title('matplotlib')
plt.legend(loc='upper left')
plt.ylim((-1.5,3.5))
plt.show()
plt.savefig('mpl_default.png')
```

![mpl_defaults.png](https://github.com/erwanp/publib/blob/master/docs/mpl_default.png)

And now the same code with the two new lines calling the 
publib functions

``` {.sourceCode .python}
from publib import set_style, fix_style
set_style('article')        # before the first plot

x = np.linspace(0,5,250)
y = np.cos(x)**2+np.random.normal(scale=0.5,size=len(x))
yav = np.cos(x)**2
plt.figure()
ax = plt.subplot()
ax.plot(x,y,'o',label='normal distribution')
ax.plot(x,yav,zorder=-1,label='average')
plt.xlabel(r'$x$')
plt.ylabel(r'$\cos^2 x$+noise')
plt.title('article')
plt.legend(loc='upper left')
plt.ylim((-1.5,3.5))

fix_style('article')  # after the axe has been created

plt.show()
plt.savefig('publib_article.png')
```

![publib_article.png](https://github.com/erwanp/publib/blob/master/docs/publib_article.png)

The [OriginPro](https://www.originlab.com/Origin) style:

```
set_style('origin')

...

fix_style('origin')
```

![publib_origin.png](https://github.com/erwanp/publib/blob/master/docs/publib_origin.png)

A combination of styles:

```
set_style(['poster', 'origin'])

...

fix_style(['poster', 'origin'])
```

![publib_poster_origin.png](https://github.com/erwanp/publib/blob/master/docs/publib_poster_origin.png)

Or, assuming you have the Latin Modern Math font installed:

```
set_style(['origin', 'latex'])

...

fix_style(['origin', 'latex'])
```

![publib_origin_latex.png](https://github.com/erwanp/publib/blob/master/docs/publib_origin_latex.png)

Run the test() routines in `publib.test` for more examples.

## Tools

The publib.tools module include independant functions to fix some common matplotlib bugs, 
or include extra features. They're usually glanced from somewhere on the web. Proper  
referencing is made in the function docstrings.

See for instance:

- `publib.tools.reset_defaults`: reset Matplotlib defaults

- `publib.tools.regenerate_fonts`: rebuild Matplotlib font cache

- `publib.tools.fix_bold_TimesNewRoman`: fix Times New Roman font appearing bold. See 
[StackOverflow](https://stackoverflow.com/questions/33955900/matplotlib-times-new-roman-appears-bold)

- `publib.tools.keep_color`: apply the same color for the next graph to plot

- `publib.tools.get_next_color`: see which color will be applied next in the color cycle state

```
plt.plot(...)
keep_color()
plt.plot(...)
```

- `publib.tools.list_font_names`: to list all fonts available in Python.

See [tools.py](https://github.com/erwanp/publib/blob/master/publib/tools/__init__.py) 
for more details

## Changes

- 0.2.2: added tools

- 0.1.9: added talk and OriginPro style

- 0.1.7 : default fonts to Times in article

## References

Some other interesting packages to make nice graphs in Matplotlib.

Add new features:

- [pypdfplot](https://github.com/dcmvdbekerom/pypdfplot): embed the script within the pdf. One single file for the figure and the code!
- [brokenaxes](https://github.com/bendichter/brokenaxes)
- [matplotlib-tools](https://github.com/terranjp/matplotlib-tools): toolbar (ruler, etc.)

Style based:

- the Matplotlib default [style feature](http://matplotlib.org/users/style_sheets.html)
- [seaborn](http://stanford.edu/~mwaskom/software/seaborn/)
- [prettyplotlib](https://github.com/olgabot/prettyplotlib)
- [garrettj403](https://github.com/garrettj403)'s matplotlib styles for [ThesisPlot](https://github.com/garrettj403/ThesisPlots)

Tips and demos of Matplotlib:

- [A great cheatsheet](https://nbviewer.jupyter.org/urls/gist.githubusercontent.com/Jwink3101/e6b57eba3beca4b05ec146d9e38fc839/raw/f486ca3dcad44c33fc4e7ddedc1f83b82c02b492/Matplotlib_Cheatsheet)
  by [Jwink3101](https://github.com/Jwink3101)

publib

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README