Metadata-Version: 2.1
Name: oneblue
Version: 0.0.3
Summary: A Simple Colormap for Matplotlib
Home-page: https://github.com/sandyzikun/oneblue.git
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Description-Content-Type: text/markdown
License-File: LICENSE

# `oneblue`

A Simple Colormap for `Matplotlib`.

![](https://github.com/sandyzikun/oneblue/raw/init/assets/yozora-lmap-x.jpeg)

## Requirements

Ensure [NumPy](https://numpy.org/) ([`NumPy` on GitHub](https://github.com/numpy/numpy/)), and [Matplotlib](https://matplotlib.org/) ([`Matplotlib` on GitHub](https://github.com/matplotlib/matplotlib/)) is installed already before installing `oneblue`.

One of most simple ways to install them is installing it with `conda`:

```sh
$ conda install numpy matplotlib
```

## Installation

Currently the latest version of `mikutoolkit` can be installed with `pip` as following:

```sh
$ pip install oneblue --upgrade
```

or [from source](https://github.com/sandyzikun/oneblue/) like other packages.

## Importation

To access `oneblue` and its functions import it in your Python code like this:

```py
>>> from matplotlib import pyplot as plt
>>> plt.style.use("whatever_u_like_ggplot_4_instance")
>>> from oneblue import oneb1ue
>>> with plt.rc_context({ "image.cmap": oneb1ue.cmap }):
...     ...
...     ...
...     plt.show()
```

## Comparison with other Colormaps in `Matplotlib`

|     Colormap  Name     |  `Nebula`[^1]  Likelihood-map  | IM<sup>2</sup>C  2019[^2]  D-1 | SST of Yellow Sea Cold Water Mass Area at 15:00, Dec 24<sup>th</sup>, 2006 |
|------------------------|--------------------------------|--------------------------------|-|
|       `"Greys"`        | ![](https://github.com/sandyzikun/oneblue/raw/init/assets/yozora-lmap-o.jpeg) | ![](https://github.com/sandyzikun/oneblue/raw/init/assets/im2c2019d01-o.jpeg) | ![](https://github.com/sandyzikun/oneblue/raw/init/assets/hcwm-sst-20061224150039-o.jpeg) |
|      `"Greys_r"`       | ![](https://github.com/sandyzikun/oneblue/raw/init/assets/yozora-lmap-r.jpeg) | ![](https://github.com/sandyzikun/oneblue/raw/init/assets/im2c2019d01-r.jpeg) | ![](https://github.com/sandyzikun/oneblue/raw/init/assets/hcwm-sst-20061224150039-r.jpeg) |
|      `"Seismic"`       | ![](https://github.com/sandyzikun/oneblue/raw/init/assets/yozora-lmap-s.jpeg) | ![](https://github.com/sandyzikun/oneblue/raw/init/assets/im2c2019d01-s.jpeg) | ![](https://github.com/sandyzikun/oneblue/raw/init/assets/hcwm-sst-20061224150039-s.jpeg) |
| `oneblue.oneb1ue.cmap` | ![](https://github.com/sandyzikun/oneblue/raw/init/assets/yozora-lmap-x.jpeg) | ![](https://github.com/sandyzikun/oneblue/raw/init/assets/im2c2019d01-x.jpeg) | ![](https://github.com/sandyzikun/oneblue/raw/init/assets/hcwm-sst-20061224150039-x.jpeg) |
| `oneblue.oneb1ue.dmap` | ![](https://github.com/sandyzikun/oneblue/raw/init/assets/yozora-lmap-y.jpeg) | ![](https://github.com/sandyzikun/oneblue/raw/init/assets/im2c2019d01-y.jpeg) | ![](https://github.com/sandyzikun/oneblue/raw/init/assets/hcwm-sst-20061224150039-y.jpeg) |

## References

[^1]: [`@sleepwalking/Nebula`](https://github.com/Sleepwalking/nebula/): Zero-data (yet trainable) probabilistic fundamental frequency estimator.
[^2]: [IMMC](http://istem.info/web/text.php?id=50)

## Extra

The Colormaps are inspired by the theme colors of Hoshino-Ichika and Luo-Tianyi.

| Name | Hoshino-Ichika (Game Character) | Luo-Tianyi (Virtual Singer of VOCALOID) |
|------|---------------------------------|-----------------------------------------|
| Theme Color | `#33AAEE` | `#66CCFF` |
| Vision | <img src="https://github.com/sandyzikun/oneblue/raw/init/assets/Hoshino-Ichika.jpeg" height=192 /> | <img src="https://github.com/sandyzikun/oneblue/raw/init/assets/Luo-Tianyi.jpeg" height=192 /> |
