cplots 0.0.1__tar.gz

cplots-0.0.1/PKG-INFO

@@ -0,0 +1,148 @@
+Metadata-Version: 2.3
+Name: cplots
+Version: 0.0.1
+Summary: C-Plots: A unified plotting library for Cosmology.
+Author: Rodrigo Calderon
+Author-email: Rodrigo Calderon <calderon.cosmoly@gmail.com>
+Requires-Dist: cplots[matplotlib,plotly,altair,getdist,pandas,polars] ; extra == 'all'
+Requires-Dist: altair>=5.0 ; extra == 'altair'
+Requires-Dist: pytest>=8.0 ; extra == 'dev'
+Requires-Dist: mypy>=1.10 ; extra == 'dev'
+Requires-Dist: ruff>=0.4 ; extra == 'dev'
+Requires-Dist: mkdocs-material>=9.5 ; extra == 'docs'
+Requires-Dist: mkdocstrings[python]>=0.25 ; extra == 'docs'
+Requires-Dist: mkdocs-marimo>=0.2.1 ; extra == 'docs'
+Requires-Dist: getdist>=1.4 ; extra == 'getdist'
+Requires-Dist: matplotlib>=3.7 ; extra == 'matplotlib'
+Requires-Dist: pandas>=1.5 ; extra == 'pandas'
+Requires-Dist: plotly>=5.0 ; extra == 'plotly'
+Requires-Dist: polars>=0.20 ; extra == 'polars'
+Requires-Dist: ultraplot>=0.1 ; extra == 'ultraplot'
+Requires-Python: >=3.10
+Provides-Extra: all
+Provides-Extra: altair
+Provides-Extra: dev
+Provides-Extra: docs
+Provides-Extra: getdist
+Provides-Extra: matplotlib
+Provides-Extra: pandas
+Provides-Extra: plotly
+Provides-Extra: polars
+Provides-Extra: ultraplot
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="docs/assets/logo-wordmark.svg" width="65%" alt="cplots">
+</p>
+
+<p align="center">
+  <strong>A backend-agnostic cosmological plotting library.</strong><br>
+  Write your analysis once; render with <code>matplotlib</code>, <code>plotly</code>, or <code>altair</code> — no lock-in.
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/cplots/"><img src="https://img.shields.io/pypi/v/cplots.svg?color=blue" alt="PyPI version"></a>
+  <a href="https://pypi.org/project/cplots/"><img src="https://img.shields.io/pypi/pyversions/cplots.svg" alt="Python versions"></a>
+  <a href="https://rcalderonb6.github.io/cplots/"><img src="https://img.shields.io/badge/docs-rcalderonb6.github.io%2Fcplots-blue" alt="Docs"></a>
+  <a href="https://github.com/rcalderonb6/cplots/actions/workflows/docs.yml"><img src="https://github.com/rcalderonb6/cplots/actions/workflows/docs.yml/badge.svg" alt="Deploy docs"></a>
+</p>
+
+---
+
+## How it works
+
+Every plot flows through three clean layers:
+
+```
+Raw arrays / DataFrames / xarray Datasets
+        ↓
+    PlotData      immutable input containers
+        ↓
+    PlotSpec      backend-agnostic IR — the decoupling boundary
+        ↓
+    Backend       matplotlib · plotly · altair
+```
+
+Plot subclasses never import backends. Backends never import plot subclasses.
+Swap the backend at call time, via a context manager, or globally — the plot code stays unchanged.
+
+---
+
+## Features
+
+- **Six plot types** — `XYPlot`, `PKSpectrum`, `ClSpectrum`, `BackgroundEvolution`, `TrianglePlot`, `XYZColored`
+- **Three backends** — publication PNG via **matplotlib**, interactive HTML via **plotly**, Vega-Lite JSON via **altair**
+- **Multi-panel figures** — compose plots into grids with colspan/rowspan, shared axes, and custom ratios
+- **LaTeX labels** — pass raw LaTeX strings through to plotly's MathJax renderer
+- **Pluggable adapters** — accepts NumPy arrays, pandas DataFrames, xarray Datasets, and GetDist `MCSamples`
+- **Zero lock-in** — third-party backends and adapters register via `pyproject.toml` entry points
+
+---
+
+## Quick example
+
+```python
+import numpy as np
+import cplots
+
+k  = np.logspace(-3, 0, 200)
+pk = k ** -1.5
+
+# Display with default backend (matplotlib)
+cplots.PKSpectrum(k, pk, label="z=0").show()
+
+# Interactive HTML with LaTeX labels
+cplots.PKSpectrum(
+    k, pk,
+    x_label=r"$k\;[h\,\mathrm{Mpc}^{-1}]$",
+    y_label=r"$P(k)\;[h^{-3}\,\mathrm{Mpc}^3]$",
+    latex_labels=True,
+).save("pk.html", backend="plotly")
+
+# Multi-panel figure
+z  = np.linspace(0, 3)
+Hz = 67.34 * np.sqrt(0.3 * (1 + z)**3 + 0.7)
+
+fig = cplots.Figure.grid([
+    [cplots.PKSpectrum(k, pk), cplots.BackgroundEvolution(z, {"H": Hz})],
+])
+fig.show()
+```
+
+### Switching backends
+
+```python
+# Per call
+plot.show(backend="plotly")
+
+# Context manager
+with cplots.backend("altair"):
+    plot.show()
+
+# Global default
+cplots.set_backend("plotly")
+```
+
+---
+
+## Installation
+
+```bash
+pip install cplots[matplotlib]              # matplotlib only
+pip install cplots[matplotlib,plotly]       # two backends
+pip install cplots[all]                     # all backends + getdist
+```
+
+**Development install:**
+
+```bash
+git clone https://github.com/rcalderonb6/cplots
+pip install -e ".[matplotlib,dev]"
+```
+
+---
+
+## Documentation
+
+Full documentation, including the API reference, user guide, and interactive examples, is available at
+[rcalderonb6.github.io/cplots](https://rcalderonb6.github.io/cplots/).

cplots-0.0.1/README.md

@@ -0,0 +1,115 @@
+<p align="center">
+  <img src="docs/assets/logo-wordmark.svg" width="65%" alt="cplots">
+</p>
+
+<p align="center">
+  <strong>A backend-agnostic cosmological plotting library.</strong><br>
+  Write your analysis once; render with <code>matplotlib</code>, <code>plotly</code>, or <code>altair</code> — no lock-in.
+</p>
+
+<p align="center">
+  <a href="https://pypi.org/project/cplots/"><img src="https://img.shields.io/pypi/v/cplots.svg?color=blue" alt="PyPI version"></a>
+  <a href="https://pypi.org/project/cplots/"><img src="https://img.shields.io/pypi/pyversions/cplots.svg" alt="Python versions"></a>
+  <a href="https://rcalderonb6.github.io/cplots/"><img src="https://img.shields.io/badge/docs-rcalderonb6.github.io%2Fcplots-blue" alt="Docs"></a>
+  <a href="https://github.com/rcalderonb6/cplots/actions/workflows/docs.yml"><img src="https://github.com/rcalderonb6/cplots/actions/workflows/docs.yml/badge.svg" alt="Deploy docs"></a>
+</p>
+
+---
+
+## How it works
+
+Every plot flows through three clean layers:
+
+```
+Raw arrays / DataFrames / xarray Datasets
+        ↓
+    PlotData      immutable input containers
+        ↓
+    PlotSpec      backend-agnostic IR — the decoupling boundary
+        ↓
+    Backend       matplotlib · plotly · altair
+```
+
+Plot subclasses never import backends. Backends never import plot subclasses.
+Swap the backend at call time, via a context manager, or globally — the plot code stays unchanged.
+
+---
+
+## Features
+
+- **Six plot types** — `XYPlot`, `PKSpectrum`, `ClSpectrum`, `BackgroundEvolution`, `TrianglePlot`, `XYZColored`
+- **Three backends** — publication PNG via **matplotlib**, interactive HTML via **plotly**, Vega-Lite JSON via **altair**
+- **Multi-panel figures** — compose plots into grids with colspan/rowspan, shared axes, and custom ratios
+- **LaTeX labels** — pass raw LaTeX strings through to plotly's MathJax renderer
+- **Pluggable adapters** — accepts NumPy arrays, pandas DataFrames, xarray Datasets, and GetDist `MCSamples`
+- **Zero lock-in** — third-party backends and adapters register via `pyproject.toml` entry points
+
+---
+
+## Quick example
+
+```python
+import numpy as np
+import cplots
+
+k  = np.logspace(-3, 0, 200)
+pk = k ** -1.5
+
+# Display with default backend (matplotlib)
+cplots.PKSpectrum(k, pk, label="z=0").show()
+
+# Interactive HTML with LaTeX labels
+cplots.PKSpectrum(
+    k, pk,
+    x_label=r"$k\;[h\,\mathrm{Mpc}^{-1}]$",
+    y_label=r"$P(k)\;[h^{-3}\,\mathrm{Mpc}^3]$",
+    latex_labels=True,
+).save("pk.html", backend="plotly")
+
+# Multi-panel figure
+z  = np.linspace(0, 3)
+Hz = 67.34 * np.sqrt(0.3 * (1 + z)**3 + 0.7)
+
+fig = cplots.Figure.grid([
+    [cplots.PKSpectrum(k, pk), cplots.BackgroundEvolution(z, {"H": Hz})],
+])
+fig.show()
+```
+
+### Switching backends
+
+```python
+# Per call
+plot.show(backend="plotly")
+
+# Context manager
+with cplots.backend("altair"):
+    plot.show()
+
+# Global default
+cplots.set_backend("plotly")
+```
+
+---
+
+## Installation
+
+```bash
+pip install cplots[matplotlib]              # matplotlib only
+pip install cplots[matplotlib,plotly]       # two backends
+pip install cplots[all]                     # all backends + getdist
+```
+
+**Development install:**
+
+```bash
+git clone https://github.com/rcalderonb6/cplots
+pip install -e ".[matplotlib,dev]"
+```
+
+---
+
+## Documentation
+
+Full documentation, including the API reference, user guide, and interactive examples, is available at
+[rcalderonb6.github.io/cplots](https://rcalderonb6.github.io/cplots/).

cplots-0.0.1/pyproject.toml

@@ -0,0 +1,48 @@
+[project]
+name = "cplots"
+version = "0.0.1"
+description = "C-Plots: A unified plotting library for Cosmology."
+readme = "README.md"
+authors = [
+    { name = "Rodrigo Calderon", email = "calderon.cosmoly@gmail.com" }
+]
+requires-python = ">=3.10"
+dependencies = []
+
+[project.optional-dependencies]
+matplotlib = ["matplotlib>=3.7"]
+plotly = ["plotly>=5.0"]
+altair = ["altair>=5.0"]
+ultraplot = ["ultraplot>=0.1"]
+getdist = ["getdist>=1.4"]
+pandas = ["pandas>=1.5"]
+polars = ["polars>=0.20"]
+dev = ["pytest>=8.0", "mypy>=1.10", "ruff>=0.4"]
+docs = ["mkdocs-material>=9.5", "mkdocstrings[python]>=0.25","mkdocs-marimo>=0.2.1"]
+all = ["cplots[matplotlib,plotly,altair,getdist,pandas,polars]"]
+
+[project.entry-points."cplots.backends"]
+matplotlib = "cplots.backends.matplotlib:MatplotlibBackend"
+plotly = "cplots.backends.plotly:PlotlyBackend"
+altair = "cplots.backends.altair:AltairBackend"
+ultraplot = "cplots.backends.ultraplot:UltraplotBackend"
+
+[build-system]
+requires = ["uv_build>=0.9.9,<0.10.0"]
+build-backend = "uv_build"
+
+[tool.ruff]
+target-version = "py310"
+line-length = 100
+exclude = ["notebooks/"]
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP"]
+
+[tool.mypy]
+python_version = "3.10"
+strict = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+

cplots-0.0.1/src/cplots/__init__.py

@@ -0,0 +1,85 @@
+"""cplots: a backend-agnostic cosmological plotting library.
+
+Three-layer architecture:
+  PlotData (immutable input) → PlotSpec IR → Backend (renders native figure)
+
+Backends (matplotlib, plotly, altair) are selected per call, via context
+manager, or globally. Third-party backends register via entry points.
+
+Example:
+    >>> import numpy as np
+    >>> import cplots
+    >>> k = np.logspace(-3, 0, 200)
+    >>> pk = k ** -1.5
+    >>> cplots.PKSpectrum(k, pk, label="P(k)").show()
+"""
+
+# Trigger backend registration by importing the backends package.
+import cplots.backends  # noqa: E402, F401
+from cplots.config import backend, resolve_backend, set_backend
+from cplots.core.base import Plot
+from cplots.core.data import (
+    BackgroundData,
+    ClData,
+    PKData,
+    PlotData,
+    TriangleData,
+    XYData,
+    XYZData,
+)
+from cplots.core.incremental import (
+    build_incrementally,
+    incremental,
+    labeled_prefixes,
+    sequence_prefixes,
+)
+from cplots.core.protocols import BackendProtocol
+from cplots.core.registry import get_backend, register_backend
+from cplots.core.spec import FigureSpec, PanelSpec, PlotSpec, Trace
+from cplots.core.theme import DARK, PUBLICATION, ThemeSpec
+from cplots.data.adapters import to_plot_data
+from cplots.figure import Figure
+from cplots.plots.background import BackgroundEvolution
+from cplots.plots.power_spectrum import ClSpectrum, PKSpectrum, PowerSpectrumBase
+from cplots.plots.triangle import TrianglePlot
+from cplots.plots.xy import XYPlot
+from cplots.plots.xyz_colored import XYZColored
+from cplots.plots.xyz_colored_grid import XYZColoredGrid
+
+__all__ = [
+    "DARK",
+    "Figure",
+    "FigureSpec",
+    "PanelSpec",
+    "PUBLICATION",
+    "BackendProtocol",
+    "BackgroundData",
+    "BackgroundEvolution",
+    "ClData",
+    "ClSpectrum",
+    "PKData",
+    "PKSpectrum",
+    "Plot",
+    "PlotData",
+    "PlotSpec",
+    "PowerSpectrumBase",
+    "ThemeSpec",
+    "Trace",
+    "TriangleData",
+    "TrianglePlot",
+    "XYData",
+    "XYPlot",
+    "XYZColored",
+    "XYZColoredGrid",
+    "XYZData",
+    "backend",
+    "build_incrementally",
+    "get_backend",
+    "incremental",
+    "labeled_prefixes",
+    "register_backend",
+    "resolve_backend",
+    "sequence_prefixes",
+    "set_backend",
+    "to_plot_data",
+]

cplots-0.0.1/src/cplots/backends/__init__.py

@@ -0,0 +1,4 @@
+from cplots.backends._base import BaseBackend
+from cplots.backends.matplotlib import MatplotlibBackend
+
+__all__ = ["BaseBackend", "MatplotlibBackend"]

cplots-0.0.1/src/cplots/backends/_base.py

@@ -0,0 +1,36 @@
+from __future__ import annotations
+
+from typing import Any
+
+
+class BaseBackend:
+    """Optional base class for backends that want automatic registration.
+
+    Subclass with the ``name`` keyword to self-register on class creation::
+
+        class MyBackend(BaseBackend, name="mybackend"):
+            def render(self, spec): ...
+            ...
+
+    The ``name`` keyword triggers :func:`~cplots.core.registry.register_backend`
+    at class-definition time so no manual registration call is required.
+    """
+
+    def __init_subclass__(cls, name: str | None = None, **kw: Any) -> None:
+        super().__init_subclass__(**kw)
+        if name is not None:
+            from cplots.core.registry import register_backend
+
+            register_backend(name, cls())
+
+    def render_figure(self, spec: Any) -> Any:
+        """Render a multi-panel FigureSpec.
+
+        Raises:
+            NotImplementedError: Subclasses that support multi-panel layouts
+                must override this method.
+        """
+        raise NotImplementedError(
+            f"{type(self).__name__} does not implement render_figure(). "
+            "Multi-panel layouts require a backend that supports FigureSpec."
+        )