Merge branch 'main' into fix/animation-noise

Author: cvanelteren

.github/workflows/build-ultraplot.yml

@@ -54,6 +54,8 @@ jobs:
   compare-baseline:
     name: Compare baseline Python ${{ inputs.python-version }} with MPL ${{ inputs.matplotlib-version }}
     runs-on: ubuntu-latest
+    env:
+      IS_PR: ${{ github.event_name == 'pull_request' }}
     defaults:
       run:
         shell: bash -el {0}
@@ -75,22 +77,25 @@ jobs:
       - name: Cache Baseline Figures
         id: cache-baseline
         uses: actions/cache@v4
+        if: ${{ env.IS_PR }}
         with:
           path: ./ultraplot/tests/baseline # The directory to cache
-          # Key is based on OS, Python/Matplotlib versions, and the PR number
-          key: ${{ runner.os }}-baseline-pr-${{ github.event.pull_request.number }}-${{ inputs.python-version }}-${{ inputs.matplotlib-version }}
+          # Key is based on OS, Python/Matplotlib versions, and the base commit SHA
+          key: ${{ runner.os }}-baseline-base-${{ github.event.pull_request.base.sha }}-${{ inputs.python-version }}-${{ inputs.matplotlib-version }}
           restore-keys: |
-            ${{ runner.os }}-baseline-pr-${{ github.event.pull_request.number }}-${{ inputs.python-version }}-${{ inputs.matplotlib-version }}-
+            ${{ runner.os }}-baseline-base-${{ github.event.pull_request.base.sha }}-${{ inputs.python-version }}-${{ inputs.matplotlib-version }}-
 
       # Conditional Baseline Generation (Only runs on cache miss)
       - name: Generate baseline from main
         # Skip this step if the cache was found (cache-hit is true)
-        if: steps.cache-baseline.outputs.cache-hit != 'true'
+        if: steps.cache-baseline.outputs.cache-hit != 'true' || !env.IS_PR
         run: |
           mkdir -p ultraplot/tests/baseline
-          # Checkout the base branch (e.g., 'main') to generate the official baseline
-          git fetch origin ${{ github.event.pull_request.base.sha }}
-          git checkout ${{ github.event.pull_request.base.sha }}
+          # Checkout the base commit for PRs; otherwise regenerate from current ref
+          if [ -n "${{ github.event.pull_request.base.sha }}" ]; then
+            git fetch origin ${{ github.event.pull_request.base.sha }}
+            git checkout ${{ github.event.pull_request.base.sha }}
+          fi
 
           # Install the Ultraplot version from the base branch's code
           pip install --no-build-isolation --no-deps .
@@ -103,7 +108,9 @@ jobs:
             ultraplot/tests
 
           # Return to the PR branch for the rest of the job
-          git checkout ${{ github.sha }}
+          if [ -n "${{ github.event.pull_request.base.sha }}" ]; then
+            git checkout ${{ github.sha }}
+          fi
 
       # Image Comparison (Uses cached or newly generated baseline)
       - name: Image Comparison Ultraplot

.gitignore

@@ -22,6 +22,9 @@ docs/_build
 docs/_static/ultraplotrc
 docs/_static/rctable.rst
 docs/_static/*
+docs/gallery/
+docs/sg_execution_times.rst
+docs/whats_new.rst
 
 # Development subfolders
 dev

docs/examples/plot_types/07_sankey.py

@@ -0,0 +1,42 @@
+"""
+Layered Sankey diagram
+======================
+
+An example of UltraPlot's layered Sankey renderer for publication-ready
+flow diagrams.
+
+Why UltraPlot here?
+-------------------
+``sankey`` in layered mode handles node ordering, flow styling, and
+label placement without manual geometry.
+
+Key function: :py:meth:`ultraplot.axes.PlotAxes.sankey`.
+
+See also
+--------
+* :doc:`2D plot types </2dplots>`
+"""
+
+import ultraplot as uplt
+
+nodes = ["Budget", "Operations", "R&D", "Marketing", "Support", "Infra"]
+flows = [
+    ("Budget", "Operations", 5.0, "Ops"),
+    ("Budget", "R&D", 3.0, "R&D"),
+    ("Budget", "Marketing", 2.0, "Mkt"),
+    ("Operations", "Support", 1.5, "Support"),
+    ("Operations", "Infra", 2.0, "Infra"),
+]
+
+fig, ax = uplt.subplots(refwidth=3.6)
+ax.sankey(
+    nodes=nodes,
+    flows=flows,
+    style="budget",
+    flow_labels=True,
+    value_format="{:.1f}",
+    node_label_box=True,
+    flow_label_pos=0.5,
+)
+ax.format(title="Budget allocation")
+fig.show()

ultraplot/__init__.py

@@ -48,6 +48,9 @@
     "Colormap": ("constructor", "Colormap"),
     "Cycle": ("constructor", "Cycle"),
     "Norm": ("constructor", "Norm"),
+    "Locator": ("constructor", "Locator"),
+    "Scale": ("constructor", "Scale"),
+    "Formatter": ("constructor", "Formatter"),
 }
 
 

ultraplot/axes/base.py

@@ -2889,10 +2889,10 @@ def _update_outer_abc_loc(self, loc):
             # Get the size of tick labels if they exist
             has_labels = True if axis.get_ticklabels() else False
             # Estimate label size; note it uses the raw text representation which can be misleading due to the latex processing
-            if has_labels:
+            if has_labels and axis.get_ticklabels():
                 _offset = max(
                     [
-                        len(l.get_text()) + l.get_fontsize()
+                        len(l.get_text()) * l.get_fontsize() * 0.6
                         for l in axis.get_ticklabels()
                     ]
                 )
@@ -3429,6 +3429,8 @@ def format(
             return
         if rc_mode == 1:  # avoid resetting
             return
+        if self._inset_parent is not None or self._panel_parent is not None:
+            return
         self.figure.format(rc_kw=rc_kw, rc_mode=rc_mode, skip_axes=True, **params)
 
     def draw(self, renderer=None, *args, **kwargs):