Metadata-Version: 2.1
Name: cmyt
Version: 1.0.0
Summary: A collection of Matplotlib colormaps from the yt project
Home-page: https://github.com/yt-project/yt
Author: The yt project
Author-email: yt-dev@python.org
License: BSD 3-Clause
Project-URL: Homepage, https://yt-project.org/
Project-URL: Source, https://github.com/yt-project/cmyt/
Project-URL: Tracker, https://github.com/yt-project/cmyt/issues
Description: # cmyt
        
        [![PyPI](https://img.shields.io/pypi/v/cmyt.svg?logo=pypi&logoColor=white&label=PyPI)](https://pypi.org/project/cmyt)
        [![Supported Python Versions](https://img.shields.io/pypi/pyversions/cmyt/0.2.0?logo=python&logoColor=white&label=Python)](https://pypi.org/project/cmyt/)
        
        [![CI](https://github.com/yt-project/cmyt/actions/workflows/ci.yml/badge.svg)](https://github.com/yt-project/cmyt/actions/workflows/ci.yml)
        [![CI (bleeding edge)](https://github.com/yt-project/cmyt/actions/workflows/bleeding-edge.yaml/badge.svg)](https://github.com/yt-project/cmyt/actions/workflows/bleeding-edge.yaml)
        [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/yt-project/cmyt/main.svg)](https://results.pre-commit.ci/latest/github/yt-project/cmyt/main)
        
        [![yt-project](https://img.shields.io/static/v1?label="works%20with"&message="yt"&color="blueviolet")](https://yt-project.org)
        [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
        
        
        <a href="http://yt-project.org"><img src="https://raw.githubusercontent.com/yt-project/yt/main/doc/source/_static/yt_logo.png" width="150"></a>
        
        Matplotlib colormaps from the yt project !
        
        ## Colormaps overview
        
        The following colormaps, as well as their respective reversed (`*_r`) versions are available
        
        ### Perceptually uniform sequential colormaps
        <p align="center">
            <img src="https://raw.githubusercontent.com/yt-project/cmyt/main/doc/overview_perceptually_uniform.png" width="800"></a>
        </p>
        
        ### Monochromatic sequential colormaps
        <p align="center">
            <img src="https://raw.githubusercontent.com/yt-project/cmyt/main/doc/overview_pixel.png" width="800"></a>
        </p>
        
        ### Miscellaneous
        <p align="center">
            <img src="https://raw.githubusercontent.com/yt-project/cmyt/main/doc/overview_misc.png" width="800"></a>
        </p>
        
        ## Installation
        
        ```shell
        python3 -m pip install cmyt
        ```
        
        ## Usage
        cmyt integrates with matplotlib in a similar fashion to
        [cmocean](https://matplotlib.org/cmocean/) or
        [cmasher](https://cmasher.readthedocs.io)
        ```python
        import numpy as np
        import matplotlib.pyplot as plt
        import cmyt  # that's it !
        
        # generate example data
        prng = np.random.RandomState(0x4D3D3D3)
        noise = prng.random_sample((100, 100))
        x, y = np.mgrid[-50:50, -50:50]
        z = 5 * np.exp(-(x ** 2 + y ** 2) / 1000)
        
        # setup the figure
        fig, ax = plt.subplots()
        ax.set(aspect="equal")
        
        # now we can refer to cmyt colormaps as strings
        im = ax.pcolormesh(x, y, z + noise, cmap="cmyt.arbre", shading="flat")
        fig.colorbar(im, ax=ax)
        ```
        <p align="center">
            <img src="https://raw.githubusercontent.com/yt-project/cmyt/main/doc/demo.png" width="400"></a>
        </p>
        
        ```python
        # alternatively, cmyt maps can also be imported as objects
        from cmyt import pastel
        
        fig, ax = plt.subplots()
        ax.set(aspect="equal")
        im = ax.contourf(x, y, z + noise, cmap=pastel)
        fig.colorbar(im, ax=ax)
        ```
        <p align="center">
            <img src="https://raw.githubusercontent.com/yt-project/cmyt/main/doc/demo_alt.png" width="400"></a>
        </p>
        
        A gallery of comparable examples using all colormaps from cmyt is available [in the test directory](https://github.com/yt-project/cmyt/tree/main/tests/baseline).
        
        
        ## About versionning
        
        cmyt uses semantic versioning as defined by https://semver.org.
        
        In practice this means that new colormaps may be added in minor patches, and any
        backward incompatible change to existing colormaps will happen as a major
        change. Likewise, adding support for new Python/Matplotlib versions will be
        considered minor changes, while droping support for EOL Python/Matplotlib
        version will be considered major. If you're developing a library that depends on
        cmyt, we recommend to set an explicit upper limit as well as a minimal one in
        your requirements as for instance
        ```
        cmyt >= 0.1.1, < 1.0.0
        ```
        with the minimal required version pointing to the e.g. the last colormap
        addition your need, and the upper limit preventing your CI to upgrade to a major
        change without your knowing. Also note that only the top level of the package is
        considered public API.
        
Keywords: visualization
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Matplotlib
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: AIX
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Typing :: Typed
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: dev
