New feature: External Contexts, and bug splats 🐛

Release Notes

This release introduces two key improvements to enhance compatibility and consistency.

External Contexts

UltraPlot provides sensible defaults by controlling matplotlib's internal mechanics and applying overrides when needed. While this approach works well in isolation, it can create conflicts when integrating with external libraries.

We've introduced a new external context that disables UltraPlot-specific features when working with third-party libraries. Currently, this context prevents conflicts with internally generated labels in Seaborn plots. We plan to extend this functionality to support broader library compatibility in future releases.

Example usage with Seaborn:

import seaborn as sns
import ultraplot as uplt

# Load example dataset
tips = sns.load_dataset("tips")

# Use external context to avoid label conflicts
fig, ax = uplt.subplots()
with ax.external():
    sns.lineplot(data=tips, x="size", y="total_bill", hue="day", ax = ax)

Standardized Binning Functions

We've standardized the default aggregation function across all binning operations to use sum. This change affects hexbin, which previously defaulted to averaging values. All binning functions now consistently use sum as the default, though you can specify any custom aggregation function via the reduce_C_function parameter.

What's Changed

• Hotfix: unsharing causes excessive draw in jupyter by @cvanelteren in #411
• Hotfix: bar labels cause limit to reset for unaffected axis. by @cvanelteren in #413
• fix: change default reduce_C_function to np.sum for hexbin by @beckermr in #408
• Add external context mode for axes by @cvanelteren in #406

Full Changelog: v1.65.1...v1.66.0

Hot-fix: add minor issue where boxpct was not parsed properly

What's Changed

• Bump the github-actions group with 2 updates by @dependabot[bot] in #398
• Fix missing s on input parsing for boxpercentiles by @cvanelteren in #400

Full Changelog: v1.65.0...v1.65.1

Enhanced Grid Layouts and Multi-Span Colorbars

🎨 UltraPlot v1.65 release notes

This release introduces substantial improvements to subplot layout flexibility and configuration management for scientific visualization.

Key Features

Non-Rectangular Grid Layouts with Side Labels (#376)
Asymmetric subplot arrangements now support proper axis labeling, enabling complex multi-panel figures without manual positioning workarounds.

Multi-Span Colorbars (#394)
Colorbars can span multiple subplots, eliminating redundant color scales in comparative visualizations.

RC-Configurable Color Cycles (#378)
Cycle objects can be set via rc configuration, enabling consistent color schemes across figures and projects.

Improved Label Sharing (#372, #387)
Enhanced logic for axis label sharing in complex grid configurations with expanded test coverage.

Infrastructure

• Automatic version checking (#377). Users can now get informed when a new version is available by setting uplt.rc["ultraplot.check_for_latest_version"] = True which will drop a warning if a newer version is available.
• Demo gallery unit tests (#386)
• Optimized CI/CD workflow (#388, #389, #390, #391)

Impact

These changes address common pain points in creating publication-quality multi-panel figures, particularly for comparative analyses requiring consistent styling and efficient use of figure space.

What's Changed

• Allow non-rectangular grids to use side labels by @cvanelteren in #376
• Test/update label sharing tests by @cvanelteren in #372
• Add version checker for UltraPlot by @cvanelteren in #377
• Feature: allow cycle objects to be set on rc by @cvanelteren in #378
• Add unittest for demos by @cvanelteren in #386
• Increase timeout on GHA by @cvanelteren in #388
• bump to 60 minutes by @cvanelteren in #389
• Skip test_demos on gha by @cvanelteren in #391
• Hotfix: minor update in sharing logic by @cvanelteren in #387
• Housekeeping for ultraplot-build.yml by @cvanelteren in #390
• Feature: Allow multi-span colorbars by @cvanelteren in #394

Full Changelog: v1.63.0...v1.65.0

🌀 New Feature: Curved Quiver

This release introduces curved_quiver, a new plotting primitive that renders compact, curved arrows following the local direction of a vector field. It’s designed to bridge the gap between quiver (straight, local glyphs) and streamplot (continuous, global trajectories): you retain the discrete arrow semantics of quiver, but you gain local curvature that more faithfully communicates directional change.

What it does

Under the hood, the implementation follows the same robust foundations as matplotlib’s streamplot, adapted to generate short, curved arrow segments instead of full streamlines. As such it can be seen as in between streamplot and quiver plots, see figure below and above.

The core types live in ultraplot/axes/plot_types/curved_quiver.py and are centered on CurvedQuiverSolver, which coordinates grid/coordinate mapping, seed point generation, trajectory integration, and spacing control:

• _CurvedQuiverGrid validates and models the input grid. It ensures the x grid is rectilinear with equal rows and the y grid with equal columns, computes dx/dy, and exposes grid shape and extent. This means curved_quiver is designed for rectilinear grids where rows/columns of x/y are consistent, matching the expectations of stream/line-based vector plotting.

• _DomainMap maintains transformations among data-, grid-, and mask-coordinates. Velocity components are rescaled into grid-coordinates for integration, and speed is normalized to axes-coordinates so that step sizes and error metrics align with the visual output (this is important for smooth curves at different figure sizes and grid densities). It also owns bookkeeping for the spacing mask.

• _StreamMask enforces spacing between trajectories at a coarse mask resolution, much like streamplot spacing. As a trajectory advances, the mask is filled where the curve passes, preventing new trajectories from entering already-occupied cells. This avoids over-plotting and stabilizes density in a way that feels consistent with streamplot output while still generating discrete arrows.

• Integration is handled by a second-order Runge–Kutta method with adaptive step sizing, implemented in CurvedQuiverSolver.integrate_rk12. This “improved Euler” approach is chosen for a balance of speed and visual smoothness. It uses an error metric in axes-coordinates to adapt the step size ds. A maximum step (maxds) is also enforced to prevent skipping mask cells. The integration proceeds forward from each seed point, terminating when any of the following hold: the curve exits the domain, an intermediate integration step would go out of bounds (in which case a single Euler step to the boundary is taken for neatness), a local zero-speed region is detected, or the path reaches the target arc length set by the visual resolution. Internally, that arc length is bounded by a threshold proportional to the mean of the sampled magnitudes along the curve, which is how scale effectively maps to a “how far to bend” control in physical units.

• Seed points are generated uniformly over the data extent via CurvedQuiverSolver.gen_starting_points, using grains × grains positions. Increasing grains increases the number of potential arrow locations and produces smoother paths because more micro-steps are used to sample curvature. During integration, the solver marks the mask progressively via _DomainMap.update_trajectory, and very short trajectories are rejected with _DomainMap.undo_trajectory() to avoid clutter.

• The final artist returned to you is a CurvedQuiverSet (a small dataclass aligned with matplotlib.streamplot.StreamplotSet) exposing lines (the curved paths) and arrows (the arrowheads). This mirrors familiar streamplot ergonomics. For example, you can attach a colorbar to .lines, as shown in the figures.

From a user perspective, you call ax.curved_quiver(X, Y, U, V, ...) just as you would quiver, optionally passing color as a scalar field to map magnitude, cmap for color mapping, arrow_at_end=True and arrowsize to emphasize direction, and the two most impactful shape controls: grains and scale. Use curved_quiver when you want to reveal local turning behavior—vortices, shear zones, near saddles, or flow deflection around obstacles—without committing to global streamlines. If your field is highly curved in localized pockets where straight arrows are misleading but streamplot feels too continuous or dense, curved_quiver is the right middle ground.

Performance

Performance-wise, runtime scales with the number of glyphs and the micro-steps (grains). The default values are a good balance for most grids; for very dense fields, you can either reduce grains or down-sample the input grid. The API is fully additive and doesn’t introduce any breaking changes, and it integrates with existing colorbar and colormap workflows.

Parameters

There are two main parameters that affect the plots visually. The grainsparameters controls the density of the grid by interpolating between the input grid. Setting a higher grid will fill the space with more streams. See for a full function description the documentation.

The size parameter will multiply the magnitude of the stream. Setting this value higher will make it look more similar to streamplot.

Acknowledgements

Special thanks to @veenstrajelmer for his implementation (https://github.com/Deltares/dfm_tools) and @Yefee for his suggestion to add this to UltraPlot! And as always @beckermr for his review.

What's Changed

• Add curved_quiver — Curved Vector Field Arrows for 2D Plots by @cvanelteren in #361
• Add Colormap parsing to curved-quiver by @cvanelteren in #369

Suggestions or feedback

Do you have suggestion or feedback? Checkout our discussion on this release.

Full Changelog: v1.62.0...v1.63.0

🚀 New Release: Configurator Handler Registration

This release introduces a powerful extension point to the configuration system — Configurator.register_handler() — enabling dynamic responses to configuration changes.

✨ New Feature: register_handler

You can now register custom handlers that execute automatically when specific settings are modified.
This is particularly useful for settings that require derived logic or side-effects, such as updating related Matplotlib parameters.

register_handler(name: str, func: Callable[[Any], Dict[str, Any]]) → None

Example (enabled by default):

def _cycle_handler(value):
    # Custom logic to create a cycler object from the value
    return {'axes.prop_cycle': new_cycler}

rc.register_handler('cycle', _cycle_handler)

Each handler function receives the new value of the setting and must return a dictionary mapping valid Matplotlib rc keys to their corresponding values. These updates are applied automatically to the runtime configuration.

---

🧩 Why It Matters

This addition:

• Fixes an issue where cycle: entries in ultraplotrc were not properly applied.
• Decouples configuration logic from Matplotlib internals.
• Provides a clean mechanism for extending the configuration system with custom logic — without circular imports or hard-coded dependencies.

---

🔧 Internal Improvements

• Refactored configuration update flow to support handler callbacks.
• Simplified rc management by delegating side-effectful updates to registered handlers.

---

💡 Developer Note

This API is designed to be extensible. Future handlers may include dynamic color normalization, font synchronization, or interactive theme updates — all powered through the same mechanism.

🚀 Release: CFTime Support and Integration

Highlights

CFTime Axis Support:
We’ve added robust support for CFTime objects throughout ultraplot. This enables accurate plotting and formatting of time axes using non-standard calendars (e.g., noleap, gregorian, standard), which are common in climate and geoscience datasets.

Automatic Formatter and Locator Selection:
ultraplot now automatically detects CFTime axes and applies the appropriate formatters and locators, ensuring correct tick placement and labeling for all supported calendar types.

Seamless Integration with xarray:
These features are designed for direct use with xarray datasets and dataarrays. When plotting data with CFTime indexes, ultraplot will handle all time axis formatting and tick generation automatically—no manual configuration required.

---

Intended Use

This release is aimed at users working with climate, weather, and geoscience data, where time coordinates may use non-standard calendars. The new CFTime functionality ensures that plots generated from xarray and other scientific libraries display time axes correctly, regardless of calendar type.

---

Example Usage

import xarray as xr
import numpy as np
import cftime
import ultraplot as uplt

# Create a sample xarray DataArray with CFTime index
times = [cftime.DatetimeNoLeap(2001, 1, i+1) for i in range(10)]
data = xr.DataArray(np.random.rand(10), coords=[times], dims=["time"])

fig, ax = uplt.subplots()
data.plot(ax=ax)

# CFTime axes are automatically formatted and labeled
ax.set_title("CFTime-aware plotting with ultraplot")
uplt.show()

---

Migration and Compatibility

• No changes are required for existing code using standard datetime axes.
• For datasets with CFTime indexes (e.g., from xarray), simply plot as usual—ultraplot will handle the rest.

---

We welcome feedback and bug reports as you explore these new capabilities!

What's Changed

• Fix edgecolor not set on scatter plots with single-row DataFrame data by @Copilot in #325
• Add suptitle_kw alignment support to UltraPlot by @Copilot in #327
• Update Documentation for abc Parameter in Subplots and Format Command by @cvanelteren in #328
• Fix subplots docs by @cvanelteren in #330
• Add members to api by @cvanelteren in #332
• rm show from tests by @cvanelteren in #335
• Revert "Fix edge case where vcenter is not properly set for diverging norms" by @beckermr in #337
• Bump the github-actions group with 2 updates by @dependabot[bot] in #339
• Extra tests for geobackends by @cvanelteren in #334
• Fix some links for docs by @cvanelteren in #341
• Fix links docs by @cvanelteren in #342
• Lazy loading colormaps by @cvanelteren in #343
• Set warning level for mpl to error by @cvanelteren in #350
• Sanitize pad and len formatters on Cartesian Axes by @cvanelteren in #346
• Fix order of label transfer by @cvanelteren in #353
• Bump the github-actions group with 2 updates by @dependabot[bot] in #354
• Add cftime support for non-standard calendars by @cvanelteren in #344

New Contributors

• @Copilot made their first contribution in #325

Full Changelog: v1.60.2...v1.61.0

Note: v1.61.0 is yanked from pypi as it contained a debug statement. This merely removes the debug.

Hotfix: double depth decorator that affected geoplots

What's Changed

• Handle non homogeneous arrays by @cvanelteren in #318
• Update Cartopy references by @rcomer in #322
• Fix inhomogeneous violin test by @rcomer in #323
• Fix issue where double decorator does not parse function name by @cvanelteren in #320

New Contributors

• @rcomer made their first contribution in #322

Full Changelog: v1.60.1...v1.60.2

Hotfixes for colors and colormaps

Minor bug fixes

What's Changed

• Fix edge case where vcenter is not properly set for diverging norms by @cvanelteren in #314
• Fix color parsing when color is not string by @cvanelteren in #315

Full Changelog: v1.60.0...v1.60.1

It's better to share!

UltraPlot extends its sharing capabilities by redefining how sharing works. As of this release, sharing will operate by looking at the subplotgrid and extending label sharing when plots are adjacent. Labels will be turned on for those subplots that

• Face and edge of the plot
• or face an empty plot space

In the past, sharing top and right labels would erroneously be turned off and could only be managed by turning the sharing feature off.

For example, consider a simple 2x2 layout. Turning on the top and right labels now looks like:

Similarly for more complex layouts the plots facing an edge will turn on their labels. Note that the limits are still shared for these subplots:

Vertical inset colorbars

UltraPlot now also supports vertical inset colorbars such as

What's Changed

• Feat vert inset cbars by @cvanelteren in #301
• Refactor colorbar loc handling by @cvanelteren in #304
• Sync _legend_dict on legend location change by @cvanelteren in #310
• fix color being parsed for none by @cvanelteren in #312
• feat: advanced axis sharing refactor + enhancements by @cvanelteren in #256

Full Changelog: v1.57.2...v1.60.0

Bug fixes for Geo dms coordinates and reverse colors/colormaps

What's Changed

• Add citation metadata (CITATION.cff, .zenodo.json) to support scholarly use by @cvanelteren in #284
• Update CITATON.cff by @cvanelteren in #286
• Add citation links to README. by @cvanelteren in #287
• Mv dynamic function to the subplotgrid by @cvanelteren in #281
• add downloads badge by @cvanelteren in #290
• replace color to orange by @cvanelteren in #291
• Hotfix add all locations to colorbar label by @cvanelteren in #295
• Fix DMS not set on some projections by @cvanelteren in #293
• Bump mamba-org/setup-micromamba from 2.0.4 to 2.0.5 in the github-actions group by @dependabot in #299
• fix late binding and proper reversal for funcs by @cvanelteren in #296

Full Changelog: v1.57.1...v1.57.2