Welcome to pycolorbar

Deployment
Activity
Python Versions
Supported Systems
Project Status
Build Status
Linting
Code Coverage
Code Quality
License
Community
Citation

Slack | Docs

The pycolorbar is still in development. Feel free to try it out and to report issues or to suggest changes.

Quick start

pycolorbar provides a way to define colormaps and colorbar settings for later use in matplotlib or xarray.

Look at the Tutorials to have an overview of the software !

Installation

pip

pycolorbar can be installed via pip on Linux, Mac, and Windows. On Windows you can install WinPython to get Python and pip running. Then, install the pycolorbar package by typing the following command in the command terminal:

pip install pycolorbar

To install the latest development version via pip, see the [documentation][doc_install_link].

conda [NOT YET AVAILABLE]

pycolorbar can be installed via conda on Linux, Mac, and Windows. Install the package by typing the following command in a command terminal:

conda install pycolorbar

In case conda forge is not set up for your system yet, see the easy to follow instructions on conda forge.

Documentation for pycolorbar

You can find the documentation under [pycolorbar.readthedocs.io][doc_link]

Tutorials and Examples

The documentation also includes some tutorials, showing the most important use cases of pycolorbar. These tutorial are also available as Jupyter Notebooks and in Google Colab:

• 1. Introduction to colormaps definition [Notebook][Colab]
• 2. Introduction to colorbars definition [Notebook][Colab]
• 3. Introduction to bivariate colorbars [Notebook][Colab]
• 4. Introduction to trivariate colorbars [Notebook][Colab]

Citation

If you are using pycolorbar in your publication please cite our paper:

TODO: GMD

You can cite the Zenodo code publication of pycolorbar by:

Ghiggi Gionata & XXXX . ghiggi/pycolorbar. Zenodo. https://doi.org/10.5281/zenodo.8131552

If you want to cite a specific version, have a look at the Zenodo site.

Requirements:

• numpy
• matplotlib

License

The content of this repository is released under the terms of the MIT license.