QB Styles

QB Styles is a python package with a light and a dark matplotlib style.

Dark style	Light style

How do I install QB Styles?

qbstyles is a Python package. To install it, simply run:

pip install qbstyles

How do I use QB Styles?

You can use the dark Matplotlib style theme in the following way:

from qbstyles import mpl_style

mpl_style(dark=True)

And to use the light Matplotlib style theme, you can do the following:

from qbstyles import mpl_style

mpl_style(dark=False)

How do I use QB Styles in Jupyter Notebooks?

⚠️ Please make sure you run from qbstyles import mpl_style and mpl_style() in different cells as shown below. See this issue for more details.

# first cell
from qbstyles import mpl_style

# second cell
mpl_style()

What chart types can use QB Styles?

Line plots
Scatter plots
Bubble plots
Bar charts
Pie charts
Histograms and distribution plots
3D surface plots
Stream plots
Polar plots

Can you show me a few examples?

To run the examples in example.ipynb, install the required packages using pip install -r requirements_notebook.txt in a Python virtual environment of your choice.

import matplotlib.pyplot as plt
from qbstyles import mpl_style

def plot(dark):
    mpl_style(dark)
    fig, axes = plt.subplots(2, 2, figsize=(15, 10))
    
    # the following functions are defined in example.ipynb 
    line_plot(axes[0, 0])
    scatter_plot(axes[0, 1])
    distribution_plot(axes[1, 0])
    ax = plt.subplot(2, 2, 4, projection='polar')
    polar_plot(ax)

plot(dark=True)

plot(dark=False)

How do I create my own styles?

Have a look at the files qb-common.mplstyle, qb-dark.mplstyle and qb-light.mplstyle. They contain many elements that you may want to customise.

To do so, create a file similar to the above files at the root of your project, and apply it after the qbstyle as follows:

import matplotlib.pyplot as plt
from qbstyles import mpl_style

mpl_style()
plt.style.use('./your-style.mplstyle')

All of matplotlibrc's options can be found here.

What licence do you use?

QB Styles is licensed under the Apache 2.0 License.

quantumblacklabs/qbstyles