kbird 0.1.0__tar.gz

kbird-0.1.0/PKG-INFO

@@ -0,0 +1,67 @@
+Metadata-Version: 2.3
+Name: kbird
+Version: 0.1.0
+Summary: kBird colourmap is way better than viridis
+Author: Alex Marshall
+Author-email: Alex Marshall <a.marshall@fathom.global>
+Requires-Dist: matplotlib>=3.10.8
+Requires-Dist: numpy>=2.4.3
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# kBird
+
+`kBird` brings CERN's **kBird** colormap into `matplotlib`. It registers the colormap and sets it as your global default.
+
+---
+
+## How to use
+
+### 1. Global default in matplotlib
+
+To use `kBird`, simply import the library and call `set()`. 
+
+```python
+
+import kbird
+kbird.set()
+
+# All plots will use kBird instead of viridis
+plt.imshow(Z) 
+```
+
+### 2. Using kBird inside a specific block
+
+If you do not want to change your global `matplotlib` defaults and only want to use `kBird` for a single plot, you can use the `style()` context manager:
+
+```python
+import kbird
+import matplotlib.pyplot as plt
+
+# Only plots generated inside this block will use kBird
+with kbird.style():
+    plt.imshow(Z)
+    plt.show()
+
+# Any plot out here will fall back to your standard matplotlib default
+plt.imshow(Z) 
+
+```
+
+### 3. Manual Colormap Access
+
+If you prefer to pass the colormap explicitly to `matplotlib` functions, you can import the colormap object directly:
+
+```python
+import matplotlib.pyplot as plt
+from kbird import kbird_cmap
+
+plt.imshow(Z, cmap=kbird_cmap)
+
+```
+
+---
+
+## License
+
+This project is licensed under the MIT License.

kbird-0.1.0/README.md

@@ -0,0 +1,56 @@
+# kBird
+
+`kBird` brings CERN's **kBird** colormap into `matplotlib`. It registers the colormap and sets it as your global default.
+
+---
+
+## How to use
+
+### 1. Global default in matplotlib
+
+To use `kBird`, simply import the library and call `set()`. 
+
+```python
+
+import kbird
+kbird.set()
+
+# All plots will use kBird instead of viridis
+plt.imshow(Z) 
+```
+
+### 2. Using kBird inside a specific block
+
+If you do not want to change your global `matplotlib` defaults and only want to use `kBird` for a single plot, you can use the `style()` context manager:
+
+```python
+import kbird
+import matplotlib.pyplot as plt
+
+# Only plots generated inside this block will use kBird
+with kbird.style():
+    plt.imshow(Z)
+    plt.show()
+
+# Any plot out here will fall back to your standard matplotlib default
+plt.imshow(Z) 
+
+```
+
+### 3. Manual Colormap Access
+
+If you prefer to pass the colormap explicitly to `matplotlib` functions, you can import the colormap object directly:
+
+```python
+import matplotlib.pyplot as plt
+from kbird import kbird_cmap
+
+plt.imshow(Z, cmap=kbird_cmap)
+
+```
+
+---
+
+## License
+
+This project is licensed under the MIT License.

kbird-0.1.0/pyproject.toml

@@ -0,0 +1,17 @@
+[project]
+name = "kbird"
+version = "0.1.0"
+description = "kBird colourmap is way better than viridis"
+readme = "README.md"
+authors = [
+    { name = "Alex Marshall", email = "a.marshall@fathom.global" }
+]
+requires-python = ">=3.12"
+dependencies = [
+    "matplotlib>=3.10.8",
+    "numpy>=2.4.3",
+]
+
+[build-system]
+requires = ["uv_build>=0.9.26,<0.10.0"]
+build-backend = "uv_build"

kbird-0.1.0/src/kbird/__init__.py

@@ -0,0 +1,42 @@
+import matplotlib as mpl
+from matplotlib.colors import LinearSegmentedColormap
+from contextlib import contextmanager
+
+_stops = [0.0, 0.125, 0.25, 0.375, 0.5, 0.625, 0.75, 0.875, 1.0]
+_red   = [0.2082, 0.0592, 0.0780, 0.0232, 0.1802, 0.5301, 0.8186, 0.9956, 0.9764]
+_green = [0.1664, 0.3599, 0.5041, 0.6419, 0.7178, 0.7492, 0.7328, 0.7862, 0.9832]
+_blue  = [0.5293, 0.8684, 0.8385, 0.7914, 0.6425, 0.4662, 0.3499, 0.1968, 0.0539]
+
+_cdict = {
+    'red':   [[_stops[i], _red[i], _red[i]] for i in range(len(_stops))],
+    'green': [[_stops[i], _green[i], _green[i]] for i in range(len(_stops))],
+    'blue':  [[_stops[i], _blue[i], _blue[i]] for i in range(len(_stops))]
+}
+
+kbird_cmap = LinearSegmentedColormap('kBird', _cdict)
+
+def set():
+    if 'kBird' not in mpl.colormaps:
+        mpl.colormaps.register(kbird_cmap, name='kBird')
+        mpl.colormaps.register(kbird_cmap, name='kbird')
+
+    mpl.rcParams['image.cmap'] = 'kBird'
+
+
+@contextmanager
+def style():
+    """Context manager to temporarily apply kBird defaults."""
+    # Register if not already done
+    if 'kBird' not in mpl.colormaps:
+        mpl.colormaps.register(kbird_cmap, name='kBird')
+        
+    old_cmap = mpl.rcParams['image.cmap']
+    mpl.rcParams['image.cmap'] = 'kBird'
+    try:
+        yield
+    finally:
+        # Restore original default afterward
+        mpl.rcParams['image.cmap'] = old_cmap
+
+
+__all__ = ['kbird', 'set']