README.md

NicePlots

A collection of nice styles and helper functions for matplotlib

How do I install?

NicePlots can be pip installed directly from PyPI

pip install niceplots

If you want to make changes

• Clone this repository, then enter the folder in the command line terminal.
• Enter pip install -e . within the niceplots folder.

Font installation (optional)

NicePlots styles use fonts that do not ship with most operating systems, so you'll need to install them separately. If they are not installed, matplotlib will revert back to its default sans-serif font, DejaVu Sans.

The font used by each style is as follows:

• doumont-light (default niceplots): CMU Bright
• doumont-dark: CMU Bright
• james-dark: Prompt
• james-light: Prompt

Install the fonts on your system and then delete Matplotlib's font cache, which is located in ~/.cache/matplotlib by default on most operating systems. Matplotlib will rebuild the font cache next time it is run and (hopefully) find the new fonts.

CMU Bright (doumont-light and doumont-dark)

The computer modern bright font can be downloaded from this link. Alternatively, on Ubuntu, the font can be installed with the following commands:

sudo apt-get update
sudo apt-get install fonts-cmu

Arch linux users can get the font by installing the otf-cm-unicode package from AUR.

Prompt (james-dark and james-light)

The Prompt font can be download from Google Fonts.

How do I get set up?

• import matplotlib.pyplot as plt and import niceplots at the top of a file where you would like to use any function defined in this package.
• Use plt.style.use(niceplots.get_style()) to set some defaults for nice-looking plots. You can also try passing different styles to get_style(), such as NicePlots' "james-dark" or any of matplotlib's styles (see the function's documentation for a full list of available NicePlots styles).
• Take advantage of NicePlots' helper functions, including (but not limited to) adjust_spines, horiz_bar, and plot_nested_pie, which are all documented in the examples gallery.
• Admire your beautiful data.

Do you have docs?

Sort of, you can find our examples gallery and API documentation here

Help, my old NicePlots code doesn't work anymore!

We made a couple of changes to the API in version 2.0.0, most of them can be fixed with a simple find and replace. Check the release notes for more details.

Contribution guidelines

• Make any changes you see fit. Please fork your own version and submit a pull request.

Who do I talk to?

• Alasdair Gray, [email protected]
• Eytan Adler, [email protected]
• Eirikur Jonsson [email protected]