ultraplot 2.4.1__tar.gz → 2.6.0__tar.gz

ultraplot-2.6.0/.github/workflows/black.yml

@@ -0,0 +1,50 @@
+name: Black autoformat
+
+on:
+  push:
+    branches:
+      - "**"
+    paths:
+      - "ultraplot/**.py"
+      - "ultraplot/**.pyi"
+      - ".github/workflows/black.yml"
+      - ".pre-commit-config.yaml"
+      - "pyproject.toml"
+
+permissions:
+  contents: write
+
+concurrency:
+  group: black-${{ github.ref }}
+  cancel-in-progress: false
+
+jobs:
+  format:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          ref: ${{ github.ref_name }}
+
+      - uses: actions/setup-python@v7
+        with:
+          python-version: "3.14"
+
+      - name: Install Black
+        run: python -m pip install black==26.5.1
+
+      - name: Format Python files
+        run: black ultraplot
+
+      - name: Commit formatting changes
+        run: |
+          if git diff --quiet -- '*.py' '*.pyi'; then
+            echo "Black made no changes."
+            exit 0
+          fi
+
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git add --update -- '*.py' '*.pyi'
+          git commit -m "Apply Black formatting"
+          git push

{ultraplot-2.4.1 → ultraplot-2.6.0}/.github/workflows/build-ultraplot.yml

@@ -53,7 +53,7 @@ jobs:
         with:
           fetch-depth: 0
 
-      - uses: mamba-org/setup-micromamba@v3.0.0
+      - uses: mamba-org/setup-micromamba@v3.1.0
         with:
           environment-file: ./environment.yml
           init-shell: bash
@@ -100,7 +100,7 @@ jobs:
 
       - uses: actions/checkout@v7
 
-      - uses: mamba-org/setup-micromamba@v3.0.0
+      - uses: mamba-org/setup-micromamba@v3.1.0
         with:
           environment-file: ./environment.yml
           init-shell: bash

{ultraplot-2.4.1 → ultraplot-2.6.0}/.github/workflows/main.yml

@@ -50,7 +50,7 @@ jobs:
 
       - name: Build test map on cache miss
         if: steps.restore-map.outputs.cache-hit != 'true'
-        uses: mamba-org/setup-micromamba@v3.0.0
+        uses: mamba-org/setup-micromamba@v3.1.0
         with:
           environment-file: ./environment.yml
           init-shell: bash
@@ -126,7 +126,7 @@ jobs:
         with:
           fetch-depth: 0
 
-      - uses: actions/setup-python@v6
+      - uses: actions/setup-python@v7
         with:
           python-version: "3.11"
 
@@ -157,7 +157,7 @@ jobs:
         with:
           fetch-depth: 0
 
-      - uses: mamba-org/setup-micromamba@v3.0.0
+      - uses: mamba-org/setup-micromamba@v3.1.0
         with:
           environment-file: ./environment.yml
           init-shell: bash

{ultraplot-2.4.1 → ultraplot-2.6.0}/.github/workflows/publish-pypi.yml

@@ -18,10 +18,18 @@ jobs:
         with:
           fetch-depth: 0
 
-      - uses: actions/setup-python@v6
+      - uses: actions/setup-python@v7
         with:
           python-version: "3.12"
 
+      - name: Pin version from tag on release builds
+        if: startsWith(github.ref, 'refs/tags/')
+        run: |
+          VERSION="${GITHUB_REF_NAME#v}"
+          echo "Using tagged version: $VERSION"
+          echo "SETUPTOOLS_SCM_PRETEND_VERSION=$VERSION" >> "$GITHUB_ENV"
+        shell: bash
+
       - name: Ensure clean tree before build
         run: |
           git diff --quiet || (git status --short && git diff && exit 1)
@@ -46,7 +54,7 @@ jobs:
 
           version=$(python -c "import ultraplot; print(ultraplot.__version__)")
           echo "Version: $version"
-          if [[ "$version" == "0."* ]]; then
+          if [[ "${{ github.event_name }}" != "pull_request" && "$version" == "0."* ]]; then
             echo "Version is not set correctly!"
             exit 1
           fi

{ultraplot-2.4.1 → ultraplot-2.6.0}/.github/workflows/test-map.yml

@@ -23,7 +23,7 @@ jobs:
         with:
           fetch-depth: 0
 
-      - uses: mamba-org/setup-micromamba@v3.0.0
+      - uses: mamba-org/setup-micromamba@v3.1.0
         with:
           environment-file: ./environment.yml
           init-shell: bash

{ultraplot-2.4.1 → ultraplot-2.6.0}/.gitignore

@@ -22,6 +22,7 @@ docs/_build
 docs/_static/ultraplotrc
 docs/_static/rctable.rst
 docs/_static/*
+!docs/_static/why_plots/
 *.html
 docs/gallery/
 docs/sg_execution_times.rst

{ultraplot-2.4.1 → ultraplot-2.6.0}/.pre-commit-config.yaml

@@ -6,7 +6,7 @@ ci:
     autofix_prs: false
     autoupdate_commit_msg: '[pre-commit.ci] pre-commit autoupdate'
     autoupdate_schedule: monthly
-    skip: []
+    skip: [black]
     submodules: false
 
 repos:

{ultraplot-2.4.1/ultraplot.egg-info → ultraplot-2.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ultraplot
-Version: 2.4.1
+Version: 2.6.0
 Summary: A succinct matplotlib wrapper for making beautiful, publication-quality graphics.
 Author-email: Casper van Elteren <caspervanelteren@gmail.com>, Luke Davis <lukelbd@gmail.com>
 Maintainer-email: Casper van Elteren <caspervanelteren@gmail.com>, "Matthew R. Becker" <becker.mr@gmail.com>
@@ -41,6 +41,8 @@ Requires-Dist: sphinx-gallery; extra == "docs"
 Requires-Dist: shibuya; extra == "docs"
 Requires-Dist: sphinx-sitemap; extra == "docs"
 Requires-Dist: typing-extensions; extra == "docs"
+Provides-Extra: stats
+Requires-Dist: scipy; extra == "stats"
 Dynamic: license-file
 
 .. image:: https://raw.githubusercontent.com/Ultraplot/ultraplot/refs/heads/main/UltraPlotLogo.svg

{ultraplot-2.4.1 → ultraplot-2.6.0}/docs/1dplots.py

@@ -276,6 +276,8 @@ with uplt.rc.context({"lines.linewidth": 3}):
 # Also, the default *x* bounds for lines drawn with :func:`~ultraplot.axes.PlotAxes.plot`
 # and *y* bounds for lines drawn with :func:`~ultraplot.axes.PlotAxes.plotx` are now
 # "sticky", i.e. there is no padding between the lines and axes edges by default.
+# This can be disabled globally with :rcraw:`axes.sticky_edges` or per-axes with
+# the ``use_sticky_edges`` attribute.
 #
 # Step and stem plots can be drawn with :func:`~ultraplot.axes.PlotAxes.step`,
 # :func:`~ultraplot.axes.PlotAxes.stepx`, :func:`~ultraplot.axes.PlotAxes.stem`, and
@@ -505,7 +507,8 @@ ax.colorbar(m, loc="b", locator=2, label="parametric coordinate")
 # ``stacked=True``. Also note the default *x* bounds for shading drawn with
 # :func:`~ultraplot.axes.PlotAxes.area` and *y* bounds for shading drawn with
 # :func:`~ultraplot.axes.PlotAxes.areax` is now "sticky", i.e. there is no padding
-# between the shading and axes edges by default.
+# between the shading and axes edges by default. This can be disabled globally with
+# :rcraw:`axes.sticky_edges` or per-axes with the ``use_sticky_edges`` attribute.
 
 # .. important::
 #

{ultraplot-2.4.1 → ultraplot-2.6.0}/docs/Makefile

@@ -21,12 +21,14 @@ html-exec:
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)
 
-# Make make clean ignore .git folder
-# The -f doesn't raise error when files/folders not found
+# Full reset of all build output and caches (gallery md5, executed notebooks,
+# doctrees). Use this only when you need a genuinely cold rebuild; plain
+# `make html` reuses cached figures and notebook outputs.
 clean:
 	rm -rf api/*
-	rm -rf "$(BUILDDIR)"/html/*
-	rm -rf "$(BUILDDIR)"/doctrees/*
+	rm -rf "$(BUILDDIR)"
+	rm -rf gallery
+	rm -rf sg_execution_times.rst
 
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option. See: https://github.com/sphinx-doc/sphinx/issues/6603

{ultraplot-2.4.1 → ultraplot-2.6.0}/docs/_static/custom.css

@@ -1250,3 +1250,225 @@ body.wy-body-for-nav
     max-width: 100%;
     height: auto;
 }
+
+/* Why UltraPlot page: before/after comparison cards */
+.uplt-why {
+    border: 1px solid var(--uplt-color-border-muted);
+    border-radius: 0.8rem;
+    background: linear-gradient(
+        180deg,
+        var(--uplt-color-white) 0%,
+        var(--uplt-color-sidebar-bg) 100%
+    );
+    box-shadow: 0 4px 14px var(--uplt-color-shadow);
+    overflow: hidden;
+}
+
+.uplt-why-mpl {
+    border-top: 4px solid #b45309;
+}
+
+.uplt-why-uplt {
+    border-top: 4px solid #178f84;
+}
+
+.uplt-why img {
+    width: 100%;
+    height: auto;
+    border-radius: 0.45rem;
+    background: var(--uplt-color-panel-bg);
+}
+
+.uplt-why-compare {
+    margin-bottom: 0.75rem;
+}
+
+.uplt-why-compare .sd-card-body {
+    padding: 0.75rem;
+    display: flex;
+    flex-direction: column;
+    gap: 0.5rem;
+}
+
+.uplt-why-compare .uplt-compare-labels {
+    display: flex;
+    justify-content: space-between;
+    gap: 0.6rem;
+    padding: 0.4rem 0.75rem 0;
+    font-weight: 700;
+    font-size: 0.85rem;
+    text-transform: uppercase;
+    letter-spacing: 0.05em;
+}
+
+.uplt-why-compare .uplt-compare-labels .uplt-label {
+    background: var(--uplt-color-panel-bg);
+    border: 1px solid var(--uplt-color-border-muted);
+    border-radius: 9999px;
+    padding: 0.1rem 0.6rem;
+}
+
+.uplt-why-compare .uplt-compare-labels .uplt-label-mpl {
+    color: #b45309;
+}
+
+.uplt-why-compare .uplt-compare-labels .uplt-label-uplt {
+    color: #178f84;
+}
+
+.uplt-compare-frame {
+    position: relative;
+    width: 100%;
+    max-width: 100%;
+    overflow: hidden;
+    border-radius: 0.45rem;
+    border: 1px solid var(--uplt-color-border-muted);
+    background: var(--uplt-color-panel-bg);
+    --uplt-compare-position: 50%;
+}
+
+.uplt-compare-frame .uplt-compare-side {
+    position: relative;
+    width: 100%;
+    overflow: hidden;
+}
+
+.uplt-compare-frame .uplt-compare-side .sd-card-body {
+    margin: 0;
+    padding: 0.75rem;
+    color: inherit;
+}
+
+.uplt-compare-frame .uplt-compare-side .sd-card-body figure {
+    width: 100%;
+    margin: 0;
+}
+
+.uplt-compare-frame .uplt-compare-side .sd-card-body figure.align-default {
+    text-align: left;
+}
+
+.uplt-compare-frame .uplt-compare-side .sd-card-body figure img {
+    width: 100%;
+    height: auto;
+    display: block;
+    margin: 0;
+}
+
+.uplt-compare-frame .uplt-compare-side.uplt-compare-uplt {
+    position: relative;
+    z-index: 1;
+    clip-path: inset(0 0 0 var(--uplt-compare-position));
+}
+
+.uplt-compare-frame .uplt-compare-side.uplt-compare-mpl {
+    position: absolute;
+    inset: 0;
+    clip-path: inset(0 calc(100% - var(--uplt-compare-position)) 0 0);
+    z-index: 2;
+}
+
+.uplt-compare-frame .uplt-compare-handle {
+    position: absolute;
+    top: 0;
+    left: var(--uplt-compare-position);
+    transform: translateX(-50%);
+    width: 2px;
+    height: 100%;
+    background: var(--uplt-color-text-secondary);
+    opacity: 0.95;
+    pointer-events: all;
+    cursor: ew-resize;
+    z-index: 3;
+}
+
+.uplt-compare-frame .uplt-compare-handle::after {
+    content: "";
+    position: absolute;
+    inset: 0 -8px;
+    width: 16px;
+}
+
+.uplt-compare-slider {
+    position: absolute;
+    width: 1px;
+    height: 1px;
+    margin: 0;
+    opacity: 0;
+    overflow: hidden;
+}
+
+.uplt-compare-slider input[type="range"] {
+    width: 1px;
+    margin: 0;
+}
+
+.uplt-compare-label-btn {
+    appearance: none;
+    border: 1px solid var(--uplt-color-border-muted);
+    border-radius: 9999px;
+    background: var(--uplt-color-panel-bg);
+    color: inherit;
+    padding: 0.1rem 0.6rem;
+    margin: 0;
+    font: inherit;
+    font-weight: 700;
+    font-size: 0.85rem;
+    letter-spacing: 0.05em;
+    line-height: 1.2;
+    text-transform: uppercase;
+    cursor: pointer;
+}
+
+.uplt-compare-label-btn:focus-visible {
+    outline: 2px solid var(--uplt-color-accent);
+    outline-offset: 2px;
+}
+
+.uplt-compare-col {
+    grid-column: 1 / -1;
+}
+
+.uplt-why-compare-row {
+    align-items: stretch;
+}
+
+.uplt-why-compare-row .uplt-why-compare-col,
+.uplt-why-compare-row .uplt-why-compare-col.sd-col {
+    flex: 0 0 100% !important;
+    width: 100% !important;
+    max-width: 100% !important;
+    grid-column: 1 / -1;
+}
+
+.uplt-why-compare-row .uplt-why-compare-hide-col {
+    display: none !important;
+}
+
+
+.uplt-why .sd-card-body > p:first-child {
+    font-weight: 700;
+    font-size: 0.9rem;
+    letter-spacing: 0.06em;
+    text-transform: uppercase;
+}
+
+.uplt-why-mpl .sd-card-body > p:first-child strong {
+    color: #b45309;
+}
+
+.uplt-why-uplt .sd-card-body > p:first-child strong {
+    color: #178f84;
+}
+
+.uplt-why .sd-card-body > p:last-child {
+    margin-top: auto;
+    padding-top: 0.35rem;
+    color: var(--uplt-color-text-secondary);
+}
+
+html.dark .uplt-why,
+html.dark-theme .uplt-why,
+[data-color-mode="dark"] .uplt-why {
+    background: linear-gradient(180deg, #252525 0%, #1f1f1f 100%);
+}

{ultraplot-2.4.1 → ultraplot-2.6.0}/docs/_static/custom.js

@@ -38,6 +38,156 @@ function getCodeDetailsBlocks() {
   return Array.from(document.querySelectorAll("details.uplt-code-details"));
 }
 
+function initWhyCompareSliders() {
+  const isWhyPage = /\/why(?:\.html)?$|\/why\.htm$/.test(
+    (window.location.pathname || "").toLowerCase(),
+  );
+  if (!isWhyPage) return;
+
+  const cards = Array.from(document.querySelectorAll(".sd-card.uplt-why"));
+  for (let i = 0; i < cards.length - 1; i += 1) {
+    const mplCard = cards[i];
+    const upltCard = cards[i + 1];
+    if (
+      !mplCard ||
+      !upltCard ||
+      !mplCard.classList.contains("uplt-why-mpl") ||
+      !upltCard.classList.contains("uplt-why-uplt")
+    ) {
+      continue;
+    }
+    i += 1;
+
+    const mplBody = mplCard.querySelector(".sd-card-body");
+    const upltBody = upltCard.querySelector(".sd-card-body");
+    if (!mplBody || !upltBody) {
+      continue;
+    }
+
+    const slider = document.createElement("div");
+    slider.className = "uplt-why-compare";
+
+    const body = document.createElement("div");
+    body.className = "sd-card-body";
+    slider.appendChild(body);
+
+    const labels = document.createElement("div");
+    labels.className = "uplt-compare-labels";
+    const leftLabel = document.createElement("button");
+    leftLabel.type = "button";
+    leftLabel.className = "uplt-label uplt-label-mpl uplt-compare-label-btn";
+    leftLabel.textContent = "Matplotlib";
+    leftLabel.addEventListener("click", () => {
+      sliderInput.value = "100";
+      onInput();
+    });
+
+    const rightLabel = document.createElement("button");
+    rightLabel.type = "button";
+    rightLabel.className = "uplt-label uplt-label-uplt uplt-compare-label-btn";
+    rightLabel.textContent = "UltraPlot";
+    rightLabel.addEventListener("click", () => {
+      sliderInput.value = "0";
+      onInput();
+    });
+    labels.appendChild(leftLabel);
+    labels.appendChild(rightLabel);
+    body.appendChild(labels);
+
+    const frame = document.createElement("div");
+    frame.className = "uplt-compare-frame";
+    frame.setAttribute(
+      "aria-label",
+      "Matplotlib and UltraPlot before/after comparison",
+    );
+
+    const mplLayer = document.createElement("div");
+    mplLayer.className = "uplt-compare-side uplt-compare-mpl";
+    mplLayer.appendChild(mplBody.cloneNode(true));
+    frame.appendChild(mplLayer);
+
+    const upltLayer = document.createElement("div");
+    upltLayer.className = "uplt-compare-side uplt-compare-uplt";
+    upltLayer.appendChild(upltBody.cloneNode(true));
+    frame.appendChild(upltLayer);
+
+    const handle = document.createElement("div");
+    handle.className = "uplt-compare-handle";
+    frame.appendChild(handle);
+
+    const sliderInput = document.createElement("input");
+    sliderInput.className = "uplt-compare-slider";
+    sliderInput.type = "range";
+    sliderInput.min = "0";
+    sliderInput.max = "100";
+    sliderInput.value = "50";
+    sliderInput.setAttribute("aria-label", "Comparison reveal amount");
+
+    const onInput = () => {
+      frame.style.setProperty("--uplt-compare-position", `${sliderInput.value}%`);
+    };
+    sliderInput.addEventListener("input", onInput);
+    onInput();
+
+    const moveHandle = (clientX) => {
+      const rect = frame.getBoundingClientRect();
+      if (!rect.width) return;
+      const ratio = (clientX - rect.left) / rect.width;
+      const clamped = Math.max(0, Math.min(1, ratio));
+      sliderInput.value = `${Math.round(clamped * 100)}`;
+      onInput();
+    };
+
+    handle.addEventListener("pointerdown", (event) => {
+      event.preventDefault();
+      handle.setPointerCapture?.(event.pointerId);
+      moveHandle(event.clientX);
+
+      const onPointerMove = (moveEvent) => {
+        moveHandle(moveEvent.clientX);
+      };
+      const onPointerUp = () => {
+        window.removeEventListener("pointermove", onPointerMove);
+        window.removeEventListener("pointerup", onPointerUp);
+        window.removeEventListener("pointercancel", onPointerUp);
+      };
+
+      window.addEventListener("pointermove", onPointerMove);
+      window.addEventListener("pointerup", onPointerUp, { once: true });
+      window.addEventListener("pointercancel", onPointerUp, { once: true });
+    });
+
+    body.appendChild(frame);
+    body.appendChild(sliderInput);
+
+    mplCard.className = "sd-card uplt-why uplt-why-compare";
+    mplCard.replaceChildren();
+    mplCard.appendChild(body);
+
+    const compareCol = mplCard.closest(".sd-col");
+    if (compareCol) {
+      compareCol.classList.add("uplt-why-compare-col");
+      compareCol.style.width = "100%";
+      compareCol.style.maxWidth = "100%";
+      compareCol.style.flex = "0 0 100%";
+    }
+
+    const compareRow = mplCard.closest(".sd-row");
+    if (compareRow) {
+      compareRow.classList.add("uplt-why-compare-row");
+      compareRow.style.display = "block";
+    }
+
+    const upltCol = upltCard.closest(".sd-col");
+    if (upltCol) {
+      upltCol.classList.add("uplt-why-compare-hide-col");
+      upltCol.style.display = "none";
+    }
+
+    upltCard.style.display = "none";
+  }
+}
+
 function initScrollChromeFade() {
   const topBar = document.querySelector(".sy-head");
   const leftBar = document.querySelector(".sy-lside");
@@ -711,6 +861,7 @@ document.addEventListener("DOMContentLoaded", function () {
 
   // Re-sync right TOC controls now that code wrappers exist.
   initShibuyaRightToc();
+  initWhyCompareSliders();
 
   const navLinks = document.querySelectorAll(
     ".wy-menu-vertical a.reference.internal",

{ultraplot-2.4.1 → ultraplot-2.6.0}/docs/api.rst

@@ -68,7 +68,6 @@ Configuration tools
 
 .. automodsumm:: ultraplot.config
    :toctree: api
-   :skip: inline_backend_fmt, RcConfigurator
 
 
 Constructor functions
@@ -79,7 +78,6 @@ Constructor functions
 
 .. automodsumm:: ultraplot.constructor
    :toctree: api
-   :skip: Colors
 
 
 Locators and formatters
@@ -110,7 +108,6 @@ Colormaps and normalizers
 
 .. automodsumm:: ultraplot.colors
    :toctree: api
-   :skip: ListedColormap, LinearSegmentedColormap, PerceptuallyUniformColormap, LinearSegmentedNorm
 
 
 Projection classes
@@ -133,6 +130,16 @@ Demo functions
    :toctree: api
 
 
+Text alignment
+==============
+
+.. automodule:: ultraplot.textalign
+   :no-private-members:
+
+.. automodsumm:: ultraplot.textalign
+   :toctree: api
+
+
 Miscellaneous functions
 =======================
 

{ultraplot-2.4.1 → ultraplot-2.6.0}/docs/conf.py

@@ -427,6 +427,10 @@ nbsphinx_execute_arguments = [
     "}",
 ]
 
+# Prefer vector graphics for sphinx ``plot`` directives so plots stay sharp
+# without high-DPI raster scaling.
+plot_formats = ["svg"]
+
 # Control notebook execution from env for predictable local/CI builds.
 # Use values: auto, always, never.
 nbsphinx_execute = os.environ.get("UPLT_DOCS_EXECUTE", "auto").strip().lower()