Metadata-Version: 2.4
Name: hiveplotlib
Version: 0.26.0rc1
Summary: Visualize Network Data with Hive Plots
Author-email: Gary Koplik <gary.koplik@geomdata.com>
License: Copyright (c) 2020 - 2024, Geometric Data Analytics, Inc.
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without modification,
        are permitted provided that the following conditions are met:
        
        Redistributions of source code must retain the above copyright notice,
        this list of conditions and the following disclaimer.
        
        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.
        
        Neither the name of Geometric Data Analytics nor the names of any 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 OWNER 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.
        
Project-URL: Documentation, https://hiveplotlib.readthedocs.io/stable/
Project-URL: Source, https://gitlab.com/geomdata/hiveplotlib
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: pandas
Provides-Extra: bokeh
Requires-Dist: bokeh; extra == "bokeh"
Provides-Extra: datashader
Requires-Dist: dask[dataframe]; extra == "datashader"
Requires-Dist: datashader; extra == "datashader"
Requires-Dist: numba>0.54.0; extra == "datashader"
Requires-Dist: seaborn; extra == "datashader"
Provides-Extra: dev
Requires-Dist: bokeh<3.7.0; extra == "dev"
Requires-Dist: cartopy; extra == "dev"
Requires-Dist: dask[dataframe]; extra == "dev"
Requires-Dist: datashader; extra == "dev"
Requires-Dist: flexitext; extra == "dev"
Requires-Dist: geopandas; extra == "dev"
Requires-Dist: holoviews<1.20.2; extra == "dev"
Requires-Dist: jupyter; extra == "dev"
Requires-Dist: networkx; extra == "dev"
Requires-Dist: numba>0.54.0; extra == "dev"
Requires-Dist: plotly; extra == "dev"
Requires-Dist: pybadges; extra == "dev"
Requires-Dist: seaborn; extra == "dev"
Requires-Dist: tqdm; extra == "dev"
Provides-Extra: docs
Requires-Dist: myst-parser; extra == "docs"
Requires-Dist: nbsphinx; extra == "docs"
Requires-Dist: pydata-sphinx-theme; extra == "docs"
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx-copybutton; extra == "docs"
Requires-Dist: toml; extra == "docs"
Provides-Extra: holoviews
Requires-Dist: bokeh<3.7.0; extra == "holoviews"
Requires-Dist: holoviews<1.20.2; extra == "holoviews"
Requires-Dist: numba>0.54.0; extra == "holoviews"
Provides-Extra: networkx
Requires-Dist: networkx; extra == "networkx"
Provides-Extra: plotly
Requires-Dist: plotly; extra == "plotly"
Provides-Extra: ruff
Requires-Dist: ruff; extra == "ruff"
Provides-Extra: testing
Requires-Dist: pytest; extra == "testing"
Requires-Dist: pytest-cov; extra == "testing"
Requires-Dist: pytest-html; extra == "testing"
Requires-Dist: pytest-timeout; extra == "testing"
Requires-Dist: pytest-xdist; extra == "testing"
Requires-Dist: toml; extra == "testing"
Dynamic: license-file

![Hiveplotlib Logo](https://hiveplotlib.readthedocs.io/stable/_static/hiveplotlib.svg)

A plotting package for generating and visualizing static Hive Plots in Python.

![Supported Python Versions Matches PSF support](https://gitlab.com/geomdata/hiveplotlib/-/raw/master/.gitlab/python_badge.svg)

[![Matplotlib Support](https://gitlab.com/geomdata/hiveplotlib/-/raw/master/.gitlab/matplotlib_badge.svg)](https://matplotlib.org/)
[![Bokeh Support](https://gitlab.com/geomdata/hiveplotlib/-/raw/master/.gitlab/bokeh_badge.svg)](https://docs.bokeh.org/en/latest/)
[![Holoviews Support](https://gitlab.com/geomdata/hiveplotlib/-/raw/master/.gitlab/holoviews_badge.svg)](https://holoviews.org/index.html)
[![Plotly Support](https://gitlab.com/geomdata/hiveplotlib/-/raw/master/.gitlab/plotly_badge.svg)](https://plotly.com/python/)
[![Datashader Support](https://gitlab.com/geomdata/hiveplotlib/-/raw/master/.gitlab/datashader_badge.svg)](https://datashader.org/)

# Installation

`hiveplotlib` can be installed via [pypi](https://pypi.org/project/hiveplotlib/):

```bash
pip install hiveplotlib
```

To uninstall, run:

```bash
pip uninstall hiveplotlib
```

By default, `hiveplotlib` supports visualization only with the [matplotlib](https://matplotlib.org/) backend, but
`hiveplotlib` also supports [bokeh](https://docs.bokeh.org/en/latest/), [holoviews](https://holoviews.org/index.html),
and [plotly](https://plotly.com/python/) visualizations, which can be installed via `pip install hiveplotlib[bokeh]`,
`pip install hiveplotlib[holoviews]`, and `pip install hiveplotlib[plotly]`, respectively.

`hiveplotlib` also supports large network visualization via the [datashader](https://datashader.org/) backend,
which can be installed as `pip install hiveplotlib[datashader]`.

# How to Use and Examples

For more on how to use the software and examples, see the
[tutorials](https://hiveplotlib.readthedocs.io/stable/notebooks/index.html) and
[gallery examples](https://hiveplotlib.readthedocs.io/stable/gallery_examples/index.html).

We recommend starting with our
[Introduction to Hive Plots](https://hiveplotlib.readthedocs.io/stable/notebooks/introduction_to_hive_plots.html) and
[Quick Start Hive Plots](https://hiveplotlib.readthedocs.io/stable/notebooks/quick_hive_plots.html) pages.

All the example notebooks are available for download as `jupyter` notebooks in the repository under the
[examples](https://gitlab.com/geomdata/hiveplotlib/-/tree/master/examples) directory.

To install this environment and associated `jupyter` kernel used to run the notebooks, clone the repository and run:

```bash
cd <path/to/repository>
bash install.sh
```

The resulting `hiveplotlib` kernel can run any of those notebooks.

# More on Hive Plots

For more on Hive Plots, see our
[Introduction to Hive Plots](https://hiveplotlib.readthedocs.io/stable/notebooks/introduction_to_hive_plots.html).

For additional resources, see:

- [http://www.hiveplot.com/](http://www.hiveplot.com/)

- Krzywinski M, Birol I, Jones S, Marra M (2011). Hive Plots — Rational Approach to
Visualizing Networks. Briefings in Bioinformatics (early access 9 December 2011,
doi: 10.1093/bib/bbr069).

# Contributing

For more on contributing to the project, see [CONTRIBUTING.md](https://gitlab.com/geomdata/hiveplotlib/-/blob/master/CONTRIBUTING.md)

## Acknowledgements

We'd like to thank Rodrigo Garcia-Herrera for his work on
[`pyveplot`](https://gitlab.com/rgarcia-herrera/pyveplot), which we referenced
as a starting point for our structural design. We also translated some of his utility
methods for use in this repository.
