Metadata-Version: 2.1
Name: mpl-histcolorbar
Version: 0.1.0
Summary: A histogram+colorbar for matplotlib
Author-email: Jannis Ahlers <jannis.ahlers@monash.edu>
License: The MIT License (MIT)
        
        Copyright (c) 2013-present Jannis Ahlers
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/jnahlers/mpl-histcolorbar
Keywords: matplotlib,colorbar,histogram
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Education
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Scientific/Engineering :: Visualization
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Provides-Extra: dev
License-File: LICENSE

<p align="center">
  <img alt="mpl-histcolorbar logo" width=60% src="https://github.com/jnahlers/mpl-histcolorbar/blob/main/docs/_static/logo.png">
</p>

# mpl-histcolorbar
[![PyPI version](https://badge.fury.io/py/mpl-histcolorbar.svg)](https://badge.fury.io/py/mpl-histcolorbar)
[![Coverage Status](https://coveralls.io/repos/github/keflavich/mpl-histcolorbar/badge.svg?branch=master)](https://coveralls.io/github/keflavich/mpl-histcolorbar?branch=master)
[![Documentation Status](https://readthedocs.org/projects/mpl-histcolorbar/badge/?version=latest)](https://mpl-histcolorbar.readthedocs.io/en/latest/?badge=latest)

A drop-in replacement for matplotlib's colorbar that shows the frequency of each color in the mappable.

## Getting started

mpl-histcolorbar is available as [`mpl_histcolorbar`](https://pypi.org/project/mpl_histcolorbar/) on PyPI:

```bash
pip install mpl_histcolorbar
```

## Usage

```python
import numpy as np
import matplotlib.pyplot as plt
from mpl_histcolorbar import histcolorbar

rng = np.random.default_rng(seed=42)
data = rng.standard_normal(size=(25, 100))
fig, ax = plt.subplots()
im = ax.imshow(data)
hcb = histcolorbar(fig, im, location="bottom")
```

![Example](https://github.com/jnahlers/mpl-histcolorbar/blob/main/docs/_static/readme_example.png)

Documentation is available at [mpl-histcolorbar.readthedocs.io](https://mpl-histcolorbar.readthedocs.io/en/latest/).


## License
Original code is licensed under the [MIT license](https://opensource.org/licenses/MIT). This project directly derives 
from [matplotlib](https://matplotlib.org/), and any use of this project is subject to
the [matplotlib license agreement](https://matplotlib.org/stable/users/project/license.html).  
