Plotting utilities for matplotlib in python
Project description
# NicePlots ## A collection of small tweaks to improve Python / plotting
![Build Status](https://github.com/mdolab/niceplots/workflows/niceplots/badge.svg) [![Documentation Status](https://readthedocs.com/projects/mdolab-niceplots/badge/?version=latest)](https://mdolab-niceplots.readthedocs-hosted.com/en/latest) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
<img src=”examples/bar_chart.png” width=”58.5%” /> <img src=”examples/niceplotsPulseResponse.png” width=”38.82%” /> <img src=”examples/ParulaContours.png” width=”62.22%” /> <img src=”examples/optProb-shaded.png” width=”35%” />
### How do I install?
Clone this repository, then enter the folder in the command line terminal.
Enter pip install -e . within the niceplots folder.
#### Font installation (optional)
Niceplots will try and use the [computer modern bright](https://tug.org/FontCatalogue/computermodernbright/) font for the best looking plots so be sure to install it as a system font if you want to recreate the style of the plots above. Otherwise, niceplots will still work but revert back to the matplotlib default sans-serif font, DejaVu Sans.
To install the font on Ubuntu, run 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.
If niceplots doesn’t recognize the font, it might be necessary to delete Matplotlib’s font cache file from its location on your computer, likely in ~/.cache/matplotlib
### How do I get set up?
Use import niceplots at the top of a file where you would like to use any function defined in this package.
Use niceplots.setRCParams() to set some matplotlib defaults for nice looking plots. Set dark_mode=True and set_background_color=True to make plots with a dark background.
Use niceplots.All() after all the plot commands to apply the niceplot standards on the figure.
To use the Matlab colormap “parula”, execute from niceplots import parula then use parula.parula_map as your colormap within your plotting script. See the contour plot example code for an example of this.
### Do you have docs?
Sort of, you can find our examples gallery and api documentation [here](https://mdolab-niceplots.readthedocs-hosted.com/en/latest)
### 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, alachris@umich.edu
Eirikur Jonsson eirikurj@umich.edu
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for niceplots-1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cfbd7cb2818016c2b8b7c59f4f8110a0596198a86b2ea5e7e7e105420400ae0b |
|
MD5 | e8e34d6cb5f26db2ce427bdf964aaf96 |
|
BLAKE2b-256 | e3d0332e8a62f720fb862d7eeb6f7f81afaedae19d16e599170fb290d685e660 |