cmcrameri


Namecmcrameri JSON
Version 1.9 PyPI version JSON
download
home_pageNone
SummaryPerceptually uniform colormaps by Fabio Crameri
upload_time2024-04-22 08:23:54
maintainerNone
docs_urlNone
authorNone
requires_python>=3.6
licenseMIT License Colormaps in cmcrameri/cm/cmaps: Copyright (c) 2020 Fabio Crameri Python scripts and packaging: Copyright (c) 2020 Callum Rollo Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # cmcrameri


[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)

![python versions](https://img.shields.io/pypi/pyversions/cmcrameri.svg)

![pypi](https://badge.fury.io/py/cmcrameri.svg) [![Downloads](https://pepy.tech/badge/cmcrameri)](https://pepy.tech/project/cmcrameri)

![anaconda badge](https://anaconda.org/conda-forge/cmcrameri/badges/version.svg) [![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/cmcrameri.svg)](https://anaconda.org/conda-forge/cmcrameri)


This is a Python wrapper around Fabio Crameri's perceptually uniform colormaps.

<https://www.fabiocrameri.ch/colourmaps/>

All credit for creating the colormaps to Fabio.
Any errors in the Python implementation of colormaps are my own.

This version is based on _Scientific colour maps_ [version 8.0](https://doi.org/10.5281/zenodo.8035877) (2023-06-14).

## Install

With `pip`:

```sh
python -m pip install cmcrameri
```

With `conda`:

```sh
conda install -c conda-forge cmcrameri
```

## Usage example

```python
import cmcrameri.cm as cmc
import matplotlib.pyplot as plt
import numpy as np

x = np.linspace(0, 1, 100)[np.newaxis, :]

plt.imshow(x, aspect='auto', cmap=cmc.batlow)
plt.axis('off')
plt.show()
```

Alternatively, the registered name string can be used.

```python
import cmcrameri # required in order to register the colormaps with Matplotlib
...
plt.imshow(x, aspect='auto', cmap='cmc.batlow')
```

## Extra instructions

You can access all the core colormaps from Fabio Crameri's list by `cmcrameri.cm.<colormapname>`.

You can use tab autocompletion on `cmcrameri.cm` if your editor supports it.

For a reversed colormap, append `_r` to the colormap name.

Categorical colormaps have the suffix `S`.

For an image of all the available colormaps without leaving the comfort of your Python session:

```python
from cmcrameri import show_cmaps

show_cmaps()
```

![Figure demonstrating the colormaps](cmcrameri/colormaps.png)

The original colormap text files are shipped as part of the package.
Find them on your system with:

```python
from cmcrameri.cm import paths

paths
```

## License

This work is licensed under an [MIT license](https://mit-license.org/).

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "cmcrameri",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "Callum Rollo <c.rollo@outlook.com>",
    "download_url": "https://files.pythonhosted.org/packages/fe/18/61ac7ea74f7c4d82ce3a1d49e9a26492b0df5a8792025066efcb318a88e2/cmcrameri-1.9.tar.gz",
    "platform": null,
    "description": "# cmcrameri\n\n\n[![Project Status: Active \u2013 The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)\n\n![python versions](https://img.shields.io/pypi/pyversions/cmcrameri.svg)\n\n![pypi](https://badge.fury.io/py/cmcrameri.svg) [![Downloads](https://pepy.tech/badge/cmcrameri)](https://pepy.tech/project/cmcrameri)\n\n![anaconda badge](https://anaconda.org/conda-forge/cmcrameri/badges/version.svg) [![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/cmcrameri.svg)](https://anaconda.org/conda-forge/cmcrameri)\n\n\nThis is a Python wrapper around Fabio Crameri's perceptually uniform colormaps.\n\n<https://www.fabiocrameri.ch/colourmaps/>\n\nAll credit for creating the colormaps to Fabio.\nAny errors in the Python implementation of colormaps are my own.\n\nThis version is based on _Scientific colour maps_ [version 8.0](https://doi.org/10.5281/zenodo.8035877) (2023-06-14).\n\n## Install\n\nWith `pip`:\n\n```sh\npython -m pip install cmcrameri\n```\n\nWith `conda`:\n\n```sh\nconda install -c conda-forge cmcrameri\n```\n\n## Usage example\n\n```python\nimport cmcrameri.cm as cmc\nimport matplotlib.pyplot as plt\nimport numpy as np\n\nx = np.linspace(0, 1, 100)[np.newaxis, :]\n\nplt.imshow(x, aspect='auto', cmap=cmc.batlow)\nplt.axis('off')\nplt.show()\n```\n\nAlternatively, the registered name string can be used.\n\n```python\nimport cmcrameri # required in order to register the colormaps with Matplotlib\n...\nplt.imshow(x, aspect='auto', cmap='cmc.batlow')\n```\n\n## Extra instructions\n\nYou can access all the core colormaps from Fabio Crameri's list by `cmcrameri.cm.<colormapname>`.\n\nYou can use tab autocompletion on `cmcrameri.cm` if your editor supports it.\n\nFor a reversed colormap, append `_r` to the colormap name.\n\nCategorical colormaps have the suffix `S`.\n\nFor an image of all the available colormaps without leaving the comfort of your Python session:\n\n```python\nfrom cmcrameri import show_cmaps\n\nshow_cmaps()\n```\n\n![Figure demonstrating the colormaps](cmcrameri/colormaps.png)\n\nThe original colormap text files are shipped as part of the package.\nFind them on your system with:\n\n```python\nfrom cmcrameri.cm import paths\n\npaths\n```\n\n## License\n\nThis work is licensed under an [MIT license](https://mit-license.org/).\n",
    "bugtrack_url": null,
    "license": "MIT License  Colormaps in cmcrameri/cm/cmaps: Copyright (c) 2020 Fabio Crameri  Python scripts and packaging: Copyright (c) 2020 Callum Rollo  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "Perceptually uniform colormaps by Fabio Crameri",
    "version": "1.9",
    "project_urls": {
        "documentation": "https://github.com/callumrollo/cmcrameri",
        "homepage": "https://pypi.org/project/cmcrameri/",
        "repository": "https://github.com/callumrollo/cmcrameri"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f9a24c88f17ee50af5093978c4d989936883f959d7d81e1e2fa093863b080c1c",
                "md5": "d0235d2646e3869f25db25b991f00b8f",
                "sha256": "daefca10cc405f437ad292bad52f704c2ba8ae692b3e100da8c25f641997e337"
            },
            "downloads": -1,
            "filename": "cmcrameri-1.9-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d0235d2646e3869f25db25b991f00b8f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 277448,
            "upload_time": "2024-04-22T08:23:52",
            "upload_time_iso_8601": "2024-04-22T08:23:52.894375Z",
            "url": "https://files.pythonhosted.org/packages/f9/a2/4c88f17ee50af5093978c4d989936883f959d7d81e1e2fa093863b080c1c/cmcrameri-1.9-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fe1861ac7ea74f7c4d82ce3a1d49e9a26492b0df5a8792025066efcb318a88e2",
                "md5": "ac1d000016a4e6e7150c3d35beabb9fa",
                "sha256": "56faf9b7f53eb03fed450137bec7dc25c1854929d7b841b9c75616fc2c357640"
            },
            "downloads": -1,
            "filename": "cmcrameri-1.9.tar.gz",
            "has_sig": false,
            "md5_digest": "ac1d000016a4e6e7150c3d35beabb9fa",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 260122,
            "upload_time": "2024-04-22T08:23:54",
            "upload_time_iso_8601": "2024-04-22T08:23:54.500935Z",
            "url": "https://files.pythonhosted.org/packages/fe/18/61ac7ea74f7c4d82ce3a1d49e9a26492b0df5a8792025066efcb318a88e2/cmcrameri-1.9.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-22 08:23:54",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "callumrollo",
    "github_project": "cmcrameri",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "cmcrameri"
}
        
Elapsed time: 0.23537s