https://github.com/mckinsey/qbstyles
QuantumBlack Matplotlib styles
https://github.com/mckinsey/qbstyles
matplotlib plotting python stylesheet
Last synced: 6 months ago
JSON representation
QuantumBlack Matplotlib styles
- Host: GitHub
- URL: https://github.com/mckinsey/qbstyles
- Owner: mckinsey
- License: other
- Created: 2019-02-07T16:22:29.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-07-10T11:27:18.000Z (almost 2 years ago)
- Last Synced: 2025-05-07T20:17:35.811Z (about 1 year ago)
- Topics: matplotlib, plotting, python, stylesheet
- Language: Jupyter Notebook
- Homepage:
- Size: 1.49 MB
- Stars: 371
- Watchers: 10
- Forks: 36
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# QB Styles
[](https://opensource.org/licenses/Apache-2.0)
[](https://pypi.org/project/qbstyles/)
[](https://pypi.org/project/qbstyles/)
[](https://github.com/ambv/black)
QB Styles is a python package with a light and a dark [`matplotlib`](https://github.com/matplotlib/matplotlib) style.
Dark style | Light style
|-----------|----------- |
|  |  |
## How do I install QB Styles?
`qbstyles` is a Python package. To install it, simply run:
```bash
pip install qbstyles
```
## How do I use QB Styles?
You can use the dark Matplotlib style theme in the following way:
```python
from qbstyles import mpl_style
mpl_style(dark=True)
```
And to use the light Matplotlib style theme, you can do the following:
```python
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](https://github.com/jupyter/notebook/issues/3691) for more details.
```python
# first cell
from qbstyles import mpl_style
```
```python
# 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`](https://github.com/quantumblacklabs/qbstyles/blob/master/example.ipynb), install the required packages using ``pip install -r requirements_notebook.txt`` in a Python virtual environment of your choice.
```python
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)
```
```python
plot(dark=False)
```
## How do I create my own styles?
Have a look at the files [qb-common.mplstyle](https://github.com/quantumblacklabs/qbstyles/blob/master/qbstyles/styles/qb-common.mplstyle), [qb-dark.mplstyle](https://github.com/quantumblacklabs/qbstyles/blob/master/qbstyles/styles/qb-dark.mplstyle) and [qb-light.mplstyle](https://github.com/quantumblacklabs/qbstyles/blob/master/qbstyles/styles/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:
```python
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](https://matplotlib.org/tutorials/introductory/customizing.html#a-sample-matplotlibrc-file).
## What licence do you use?
QB Styles is licensed under the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0).