callumrollo/cmcrameri

Making Fabio Crameri's perceptually uniform colourmaps for geosciences available on PyPI and conda-forge

cmcrameri's Issues

Correct use of BatlowW and BatlowK

As detailed in #24 by tobiscode, batlowW and batlowK are now acceptable as categorical colormaps

BatlowS categorical colormap

I would like to define the matplotlib cycler to use BatlowS but I haven't managed to get it working as I can't access the list of colors for the cycle. Is there already a way of doing so? If not, what would be the best way to implement it?

New release

Let's stay ahead of the curve and release a new version with the matplotlib deprecation fix from #15 ?

Let me know if I can help with that.

Add scientific color map version number

The is a great project! I'm glad that someone finally put this on pip and conda.

I just have two small suggestions:

First, I think that it would be helpful if you could add the version of the Scientific Color Maps that you are using. These get updated from time to time, so it would be good to know what version is being used in cmcrameri. What if you added something like this to the init file? __scm_version = 7.0 or __version_scm = 7.0

Second, as long as you are adding versions, it would be helpful to also define __version. Perhaps the easiest way to do this is with the versioneer project, which takes the version from the tag.

Adding stub file

Adding stub file of cm.py would be very helpful for type checking and auto completing colormaps.

from matplotlib.colors import ListedColormap
from pathlib import Path

paths: list[Path]
cmaps: dict[str, ListedColormap]

def show_cmaps(*, ncols: int = ..., figwidth: int = ...) -> None: ...

acton: ListedColormap
acton_r: ListedColormap
actonS: ListedColormap
bam: ListedColormap
bam_r: ListedColormap
bamako: ListedColormap
bamako_r: ListedColormap
bamakoS: ListedColormap
⋮

I generated cm.pyi stub file with this script (mypy needed).

import subprocess
from pathlib import Path

from cmcrameri.cm import cmaps

if __name__ == "__main__":
    subprocess.check_output(["stubgen", "-o", ".", "cmcrameri/cm.py"])

    path = Path(__file__).parent / "cm.pyi"
    assert path.exists()

    with path.open("a", encoding="utf-8") as f:
        for cmap in cmaps:
            f.write(f"\n{cmap}: ListedColormap")

These lines were added for typing paths and cmaps.

paths: list[Path]
cmaps: dict[str, ListedColormap]
paths, cmaps = _load_cmaps()

Update the colormaps to Scientific colour maps version 8.0

Hi there,

Nice work on integrating the Scientific colour maps into python (and pip). Could you also update the version of the code in pip from colour maps version 7 to version 8?

Thanks,
Zak

Documentation link is broken

The pyproject.toml (and thus PyPI entry) lists https://callumrollo.github.io/cmcrameri as a documentation link. However, that link generates a 404 page.

registering the colormaps with Matplotlib with original name

Is your feature request related to a problem? Please describe.
My problem is I prefer to have something like
import cmcrameri # required in order to register the colormaps with Matplotlib
...
plt.imshow(x, aspect='auto', cmap='batlow')

Describe the solution you'd like
I think we don't need cmap_reg_prefix = "cmc."

I really appreciate if you can explain me how it might be problematic?

Best regards,
Mohammad

Is your ignore word list correct?

In your codespell configuration, you configured it to ignore words:

- repo: https://github.com/codespell-project/codespell
  rev: v2.2.5
  hooks:
    - id: codespell
      args:
        - --ignore-words-list=buda

Based on the documentation, this should be a word list.

The closest buda file I can find is here, it contains a list of numbers.

Package naming

Hello! Your package looks like a more-complete and better version of my own package (https://github.com/gwerbin/scientific-colourmaps) which has the same name on PyPI (https://pypi.org/project/scientific-colourmaps/), and which I have all but completely abandoned.

If you are interested, I'd be happy to turn over the scientific-colourmaps name to you. I have no personal interest in maintaining my own package, and I will probably be using yours in going forward in my own work.

Rename master to main

@callumrollo would you be OK with the branch name change?

Move to version 7

New version out today!
https://zenodo.org/record/4491293