Metadata-Version: 2.1
Name: cornerhex
Version: 0.4.0
Summary: Package to visualize multi-dimensional data in hexbin pairwise plots.
Author-Email: "Sebastian.stammler" <sebastian.stammler@gmail.com>
Maintainer-Email: Sebastian Stammler <sebastian.stammler@gmail.com>
License: BSD 3-Clause License
         
         Copyright (c) 2023, Sebastian Stammler
         
         Redistribution and use in source and binary forms, with or without
         modification, are permitted provided that the following conditions are met:
         
         1. Redistributions of source code must retain the above copyright notice, this
            list of conditions and the following disclaimer.
         
         2. Redistributions in binary form must reproduce the above copyright notice,
            this list of conditions and the following disclaimer in the documentation
            and/or other materials provided with the distribution.
         
         3. Neither the name of the copyright holder nor the names of its
            contributors may be used to endorse or promote products derived from
            this software without specific prior written permission.
         
         THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
         AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
         IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
         DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
         FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
         DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
         SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
         CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
         OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
         OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
         
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Education
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Scientific/Engineering :: Visualization
Project-URL: Homepage, https://cornerhex.readthedocs.io/
Project-URL: Repository, https://github.com/stammler/cornerhex/
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: scipy
Description-Content-Type: text/markdown

# cornerhex

[![Documentation Status](https://readthedocs.org/projects/cornerhex/badge/?version=latest)](https://cornerhex.readthedocs.io/en/latest/?badge=latest) [![GitHub](https://img.shields.io/github/license/stammler/cornerhex) ](https://github.com/stammler/cornerhex/blob/master/LICENSE) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://github.com/stammler/cornerhex/blob/master/.github/CODE_OF_CONDUCT.md)  
[![PyPI - Downloads](https://img.shields.io/pypi/dm/cornerhex?label=PyPI%20downloads)](https://pypistats.org/packages/cornerhex)


`cornerhex` is a package to visualize multidimensional data in matrix corner plots, for example the results of Markov Chain Monte Carlo (MCMC) methods. Instead of 2d histograms or scatter plots it uses `matplotlib.pyplot.hexbin`. `cornerhex` can be easily costumized with different color schemes.

![Cornerhex](docs/source/_static/cornerhex.jpg)

## Installation

`cornerhex` can be installed via PyPI.

`pip install cornerhex`

## Documentation

For the usage of `cornerhex` please have a look at its [documentation](https://cornerhex.rtfd.io/).

* [1. Quickstart](https://cornerhex.readthedocs.io/en/latest/1_quickstart.html)
* [2. Customizations](https://cornerhex.readthedocs.io/en/latest/2_customizations.html)
* [A. Contributing / Bug reports / Features requests](https://cornerhex.readthedocs.io/en/latest/A_contrib_bug_feature.html)

## Acknowledgements

`cornerhex` is free to use and modify. Please acknowledge this repository when using `cornerhex` in a publication.

`cornerhex` has been inspired by `corner.py` [(Foreman-Mackey, 2016)](http://dx.doi.org/10.21105/joss.00024).