Changelog

Changelog#

Release versions follow Semantic Versioning i.e., <major>.<minor>.<patch>.

Backward incompatible breaking changes will only be introduced in <major> versions, with advance notice provided in the 🔥 Deprecations section of a prior <minor> release.

v0.6.0.dev1031 (2026-06-12)#

💣 Breaking Changes#

#1468: Adopted PEP 570 and PEP 3102 to enforce clarity on position-only and keyword-only parameters in public API functions and methods. (@bjlittle)
#1751: Renamed the following geovista download command line interface (CLI) flags --image to --images, and --raster to --rasters. (@bjlittle)
#1984: Renamed the utility function sanitize_data to geovista.common.sanitize_vtk(). (@bjlittle)
#2176: Renamed the convenience dataclass SampleStructuredXYZ to geovista.pantry.data.SamplePointsXYZ. (@bjlittle)
#2259: Replaced the geovista.theme module with geovista.themes. Previously the global plotting theme was updated as a side-effect by importing geovista.theme. Instead geovista.themes adopts the new extensible pyvista.plotting.themes.Theme plugin registry framework for third-party packages available from >=0.48.0. (@bjlittle)

✨ New Features#

#1368: Added the geovista.geodesic.BBox.outline property to provide the outline edges of the geometry defining the associated geodesic bounding-box manifold. (@bjlittle)
#1499: Added the geovista --data-version option to the command line interface (CLI) to show the configured geovista-data version. (@bjlittle)
#1751: Added the --doc-images and --unit-images flags to the geovista download command line interface (CLI) to download documentation test and unit test assets separately. (@bjlittle)
#1872: Added the bbox property to the geovista.geoplotter.GeoPlotterBase allowing users to consistently subset the render so that only geometries enclosed by the bounding-box are rendered, including coastlines, base layers, meshes, graticule meridians/parallels and their labels. Closes #1869. (@RobWatersMet)
#1908: Added alternative geovista.geodesic.BBox workflow equivalent to enclosed(). A BBox instance is now callable, extracting the region from the single argument mesh contained within its geodesic bounded-box manifold e.g., bbox(mesh) is equivalent to bbox.enclosed(mesh). The behaviour of the BBox instance is configured with the outside, preference and tolerance getter/setter properties. (@bjlittle)
#1985: Added the utility function geovista.common.sanitize() to purge standard index arrays from one or more meshes. (@bjlittle)
#2014: Added a new factor keyword to geovista.gridlines.create_meridians() and geovista.gridlines.create_parallels() methods. This new keyword and the existing n_samples keyword are have also been made available via the geovista.geoplotter.GeoPlotterBase.add_graticule() convenience function. Closes #1994. (@ukmo-ccbunney)
#2079: Added --tidy option to geovista download to remove old asset directories from the geovista cache whilst keeping the current data version. Closes #2073. (@ukmo-ccbunney)
#2102: Added graticule actor naming for meridians, parallels and labels thus allowing them to be easily updated or removed from the plotter scene. (@bjlittle)
#2185: Added initial pyvista.StructuredGrid support with the geovista.bridge.Transform.to_structured_grid() method, along with a supporting Grid gallery section. (@bjlittle)
#2259: Added the geovista.themes module which adopts the extensible pyvista.plotting.themes.Theme plugin registry framework for third-party packages (pyvista >=0.48.0). Includes the new GeoVistaDocumentTheme and GeoVistaTheme both of which are discoverable and registered by pyvista through entry-points (PEP621). The GeoVistaTheme will be loaded and enabled by default. Override this behaviour with the GEOVISTA_DISABLE_PLOT_THEME environment variable. Additionally provisions the following functionality:
(@bjlittle)
#676: Added support for 3D vectors in geovista.bridge.Transform.from_points() (@pp-mo)
#997: Added NASA Black Marble “night lights” global texture geovista.pantry.textures.black_marble(). Closes #992. (@bjlittle)

🚀 Enhancements#

#1300: Made the entire code base mypy compliant. This should make development faster and more intuitive for anyone using an IDE and/or any sort of type-checking. (@trexfeathers)
#1389: Extended the geovista.theme to automatically reposition an outlined and filled scalar bar for improved readability. (@bjlittle)
#1472: Migrated infrastructure from tox to pixi 🧚. Closes #154 and #170. (@bjlittle)
#1982: Enhanced geovista.geodesic.BBox.enclosed() to support geodesic manifold extraction of projected surfaces. (@bjlittle)
#1990: Enabled the allow_empty_mesh option for our geovista.theme, which permits empty meshes to be added to a plotter scene without exception. (@bjlittle)
#2023: Updated geovista.geodesic.BBox to allow corner points to be specified in different projections via new crs keyword (defaults to geovista.crs.WGS84). Closes #1986. (@ukmo-ccbunney)
#2033: Optimised geovista.geoplotter.GeoPlotterBase manifold extraction introduced by #1872 which is now specified through the generic manifold keyword argument instead of bbox, and accessed through the manifold property. Additionally, empty meshes may be added to a GeoPlotter without exception. (@bjlittle)

🐛 Bug Fixes#

#1184: Fixed geovista.bridge.Transform.from_points() to create a mesh from scalar spatial points. (@bjlittle)
#1202: Configured bespoke User-Agent within requests header of pooch.Pooch.fetch() to avoid flaky HTTP 403 Forbidden error responses when downloading assets from the geovista-data repository. (@bjlittle)
#1301: Fixed geovista.common.from_cartesian() to handle polar points with no associated cell. (@bjlittle)
#1436: Fixed geovista.cache tests for Windows platform. (@beroda)
#1466: Ensured to close the pooch.Pooch cache registry after configuration. (@bjlittle)
#1956: Fixed gallery carousel generation to support mixed-case URL targets for sphinx-design card carousels. (@tkknight)
#1977: Fixed geovista.transform such that transform_mesh(), transform_point(), and transform_points() correctly handle a projected CRS source transformation. Additionally, geovista.geoplotter.GeoPlotterBase.add_mesh() correctly renders a projected CRS geometry within a plotter scene. (@bjlittle)
#2018: Fixed issue where mesh_args were not always being passed to the GeoPlotter when adding graticule meridians/parallels. (@ukmo-ccbunney)
#2042: Removed the geovista.theme opinionated scalar bar configuration for fixed position and size. Rather, default to adaptive positioning and scale behaviour offered by pyvista, leaving the user to customise. Otherwise a geovista themed scalar bar can easily render incorrectly. (@bjlittle)
#2050: Added defensive guard within geovista.geoplotter.GeoPlotterBase.add_mesh() prior to accessing the is_empty property, which does not exist on all pyvista instances. (@bjlittle)

🔗 Dependencies#

#1000: Skip the tests.bridge.test_from_tiff tests if the rasterio optional package dependency is not installed. (@bjlittle)
#1001: Skip individual geovista.examples image tests if their optional package dependencies are not installed. (@bjlittle)
#1013: Introduced minimum pin sphinx-tags >=0.4 for multi-line tags support. (@bjlittle)
#1019: Introduced minimum pin sphinx-autoapi >=3.0.0 and purge use of obsolete autoapi_type configuration option. (@bjlittle)
#1020: Added the sphinx-changelog package dependency for rendering a changelog from news fragments using towncrier and generating a release changelog. (@bjlittle)
#1039: Introduced temporary maximum pin towncrier <24.7.0 due to breaking change for sphinx-changelog. (@bjlittle)
#1040: Bumped mambaforge from 22.9 to 23.11 for readthedocs and introduced minimum pin lazy_loader >=0.4. (@bjlittle)
#1051: Introduced minimum pin sphinx-autoapi >=3.2.0. (@bjlittle)
#1067: Unpinned towncrier and introduced minimum pin sphinx-changelog >=1.6.0. (@bjlittle)
#1118: Adopted Scientific Python SPEC-0, a common time-based policy for dropping dependencies. This replaces the NEP-29 deprecation policy. (@bjlittle)
#1157: Introduced temporary minimum pin h3-py ==3.7.7 to avoid breaking major release 4.x behaviour. (@bjlittle)
#1178: Dropped the optional pyarrow dependency as pandas >2.2.0 no longer issues a DeprecationWarning. (@bjlittle)
#1188: Introduced minimum pin rasterio >=1.4.2 to support gdal >=3.10.0. (@bjlittle)
#1242: Enabled sphinx.ext.duration to assist with identifying documentation building bottlenecks. (@bjlittle)
#1243: Adopted numpy >=1.25 minimum pin to comply with SPEC-0 package deprecation policy. (@bjlittle)
#1255: Avoid using pydata-sphinx-theme 0.16.1, see #1247. (@bjlittle)
#1276: Introduced temporary maximum pin pydata-sphinx-theme <0.16.0, see #1247. (@bjlittle)
#1372: Introduced minimum pin sphinx-gallery >=0.17 for README.rst to GALLERY_HEADER.rst migration. (@bjlittle)
#1428: Introduced minimum pin setuptools >=77.0.3 to support PEP 639 changes to license and license-files fields in the pyproject.toml. (@bjlittle)
#1494: Introduced minimum pin pyvista >=0.45.0 and dropped the pytest plugin pytest-xvfb for headless display support. (@bjlittle)
#1496: Extended distribution support to cover py313. (@bjlittle)
#1515: Introduced minimum pin ruff >=0.12.0. (@bjlittle)
#1561: Introduced pin trame-vtk ==2.8.15 to avoid subplot interactive scene behaviour regression. (@bjlittle)
#1572: Added pytest-pretty plugin for pretty printing of the pytest summary. (@bjlittle)
#1730: Bumped pixi dependencies. (@bjlittle)
#1760: Added vtk-xref sphinx extension for linking directly to VTK’s documentation using the :vtk: reference role. (@bjlittle)
#1763: Refreshed the geovista.report.Report package dependencies. (@bjlittle)
#1808: Added sphinxcontrib-mermaid sphinx extension for rendering embedded mermaid diagrams. (@bjlittle)
#1943: Added sphinxcontrib-bibtex sphinx extension for BibTeX style citations and references. (@bjlittle)
#2064: Bumped the minimum pin pyvista >=0.47.0. (@bjlittle)
#2072: Refreshed the geovista.report.Report to reflect the package migration from nest-asyncio to nest-asyncio2 for pyvista >=0.47.0. (@bjlittle)
#2128: Migrated from the obsolete libgl1-mesa-glx package to the modern equivalent libgl1 and libglx-mesa0. (@bjlittle)
#2183: Added the geocoding package geopy as a core dependency. (@bjlittle)
#2199: Added sphinx-sitemap sphinx extension to generate sitemaps.org compliant documentation sitemaps. (@bjlittle)
#2202: Added sphinx-iconify sphinx extension to use iconify-icon web component. (@bjlittle)
#2240: Added the check-manifest package dependency to the devs pixi 🧚 feature. (@bjlittle)
#2254: Added the jupyterlab package dependency to the devs pixi 🧚 feature, and added the wurlitzer package dependency to the docs pixi 🧚 feature. (@bjlittle)
#2259: Bumped the minimum pin pyvista >=0.48.0. (@bjlittle)
#2266: Adopted trame-pyvista package as a managed replacement for trame, trame-client, trame-server, trame-vtk and trame-vuetify. (@bjlittle)

💽 Assets#

#1185: Updated the geovista.cache to reference geovista-data =2024.10.2, which includes the corrected NASA Blue Marble texture. (@bjlittle)
#1303: Updated the geovista.cache to reference geovista-data =2025.1.4, which includes new vector data assets. (@bjlittle)
#1765: Updated the geovista.cache to reference geovista-data =2025.10.2, which includes the documentation test image assets. (@bjlittle)
#1886: Updated the geovista.cache to reference geovista-data =2025.12.0, which includes the rehosted FESOM time-series decimated to the first time-step. (@bjlittle)
#1908: Updated the geovista.cache to reference geovista-data =2025.12.1, which includes a new BBox image unit test asset. (@bjlittle)
#1977: Updated the geovista.cache to reference geovista-data =2026.01.1, which includes new geovista.transform.transform_mesh() and geovista.geoplotter.GeoPlotterBase.add_mesh() image unit test assets. (@bjlittle)
#1982: Updated the geovista.cache to reference geovista-data =2026.01.2, which includes new geovista.geodesic.BBox.enclosed() image unit test assets. (@bjlittle)
#2033: Updated the geovista.cache to reference geovista-data =2026.02.0, which includes the new Plotter Extraction image unit test asset. (@bjlittle)
#2035: Updated the geovista.cache to reference geovista-data =2026.02.1, which includes updated point-cloud and DYNAMICO image unit test assets. (@bjlittle)
#2064: Updated the geovista.cache to reference 2026.02.5, which includes updated documentation image test filenames as generated by the pyvista-plot directive for pyvista >=0.47.0. (@bjlittle)

📚 Documentation#

#1006: Added sphinx Internationalization support. (@tkoyama010)
#1009: Enabled rendering a version badge in the primary sidebar, and a latest to stable version banner announcement for documentation on readthedocs. (@bjlittle)
#1010, #1012: Updated the version announcement banner for readthedocs. (@bjlittle)
#1013: Refactored structure of geovista.examples sphinx-tags. Closes #823. (@bjlittle)
#1014: Moved the tags link from the primary sidebar to a sphinx-design card in the Reference section. (@bjlittle)
#1016: Added changelog and whatsnew sphinx-design cards to the Reference section. (@bjlittle)
#1022: Fixed unset author in page footer of documentation. (@bjlittle)
#1023: Renamed the runtime generated examples gallery carousel from gallery-carousel.rst to gallery_carousel.rst in order to comply with implicit documentation file naming convention. (@bjlittle)
#1025: Added initial towncrier infrastructure to support the changelog. (@bjlittle)
#1026: Retro generated changelog entries for all relevant pull-request post 0.5.0 release. (@bjlittle)
#1053: Adopted sphinx-autoapi 3.2.1 templates. (@bjlittle)
#1054: Updated the Region Manifold Extraction tutorial to include the approximate article reading time and also shorten links within margin notes for readability. (@bjlittle)
#1055: Cross-referenced module headings to improve primary sidebar readability for the API Reference section. (@bjlittle)
#1056: Added the initial What’s New infrastructure. (@bjlittle)
#1057: Updated the What’s New to reference the associated release Discussion. (@bjlittle)
#1058: Clarified pending unreleased What’s New details as To Be Done (TBD). (@bjlittle)
#1070: Updated the towncrier changelog template. (@bjlittle)
#1072: Added Changelog contributor guidelines. (@bjlittle)
#1073: Rebranded the CLI icon from to . (@bjlittle)
#1075: Introduced CONTRIBUTING.md. (@bjlittle)
#1077: Updated README.md with introduction for Star History section. (@bjlittle)
#1080: Updated the Changelog contributor guidelines. (@bjlittle)
#1085: Added buttons to the reference About section. (@bjlittle)
#1096: Documented the changelog quality assurance performed by the ci-changelog Action. (@bjlittle)
#1099: Adjusted the Region Manifold Extraction tutorial to render better on reduced footprint mobile platforms. (@bjlittle)
#1109: Improved README.md accessibility. (@bjlittle)
#1152: Used explicit strings in enum.StrEnum instances (instead of auto()), thus making the documentation clearer. (@trexfeathers)
#1183: Adopted sphinx-autoapi 3.3.3 templates. (@bjlittle)
#1226: Resolved unnecessary linkcheck URL redirects. (@bjlittle)
#1269: Rebranded the changelog Font Awesome icon. (@bjlittle)
#1280: Added a convenience link in the GeoVista 101 sidebar to the changelog. (@bjlittle)
#1284: Added a gallery example for region manifold extraction using geovista.geodesic.wedge(). Closes #1285. (@ESadek-MO)
#1294: Updated the docstring of the region manifold extraction example. (@bjlittle)
#1305: Added a gallery example using pyvista.PolyDataFilters.contour_banded(). (@HGWright)
#1306: Added the new sample sphinx-tags category. (@bjlittle)
#1307: Renamed the gallery examples Region Extraction section to Extraction to maintain the primary sidebar menu in alphabetical order. (@bjlittle)
#1309: Added references to the new cast, contour and triangulate sphinx-tags for the filter category. (@bjlittle)
#1312: Added trame admonition for open Issue regarding contour_banded() interactive scene rendering. See Contour. (@bjlittle)
#1328: Removed use of the shadow option from all Examples titles and scalar bars, as shadowed text does not render correctly with trame in the Interactive Scene on readthedocs. (@bjlittle)
#1339: Simplified several Examples by using geovista.pantry.meshes instead of loading geovista.pantry.data to construct sample meshes. (@bjlittle)
#1362: Enabled tooltips for the Tutorials and README.md gallery carousel, and disabled sphinx-tippy tooltips for the gallery Examples and Tags. (@bjlittle)
#1364: Added a cubed-sphere panel region extraction gallery example using geovista.geodesic.panel(). (@bjlittle)
#1376: Added the Domain gallery section, including the Clouds and Clouds (Projected) examples. (@bjlittle)
#1379: Added the new resolution sphinx-tags category. (@bjlittle)
#1385: Reduced the Clouds and Clouds (Projected) examples by rendering only a single cloud mesh in order to reduce documentation build time. (@bjlittle)
#1388: Updated gallery Examples to use an outlined and filled scalar bar to aid readability. The scalar bar is also repositioned and resized by geovista.theme. (@bjlittle)
#1391: Enabled sphinx-build optimisation to distribute its workload automatically across the number of available CPUs. (@bjlittle)
#1395: Enabled sphinx-gallery to distribute its workload automatically across the number of available CPUs. Disable by setting the GEOVISTA_SPHX_GLR_SERIAL environment variable. (@bjlittle)
#1424: Converted pyvista documentation URLs to use snake_case post pyvista v0.45.0 release. Reference pyvista #7169. Closes #1423. (@bjlittle)
#1518: Added support for optional pyvista plot directives of inline documentation to streamline building execution time. Includes the new make html-inline command. Closes #1150. (@bjlittle)
#1567: Updated README.md and Installation section to include pixi 🧚 instructions. Closes #1476. (@bjlittle)
#1579: Added the Pixi Workflow section to document the pixi 🧚 tasks available to clean, build and render the documentation. (@bjlittle)
#1583: Added introductions to each gallery example section. (@bjlittle)
#1606: Registered the console prompt ($) with sphinx-copybutton to automatically excluded it when copying console code blocks. (@bjlittle)
#1616: Added reference to pixi 🧚 install instructions. (@bjlittle)
#1628: Added a VHS tape recording to Installation showing a developer install with pixi 🧚. (@bjlittle)
#1631: Fixed VTKBook broken URL. Closes #1626. (@bjlittle)
#1633: Added a VHS tape recording to the README.md showing how to create a new pixi 🧚 project, install, activate then import geovista. (@bjlittle)
#1653: Rebranded the geovista title using La Machine Company TrueType font. (@bjlittle)
#1660: Updated the Installation section to include uv instructions. (@bjlittle)
#1669: Updated the intersphinx mapping for cartopy, which is now hosted on readthedocs. (@bjlittle)
#1676: Refreshed README.md plotting example images. (@bjlittle)
#1681: Refreshed Tutorials card image for Region Manifold Extraction. (@bjlittle)
#1684: Refreshed Key Bindings GIFs and static images. (@bjlittle)
#1762: Applied the :vkt: role from the sphinx extension vtk-xref to cross-reference items within the VTK documentation. (@bjlittle)
#1764: Adopted the pyvista document_build plotting theme style for our documentation. (@bjlittle)
#1818: Used the pyvista.CameraPosition to explicitly clarify the camera position vectors in the GeoTIFF DEM gallery example. (@bjlittle)
#1821: Enabled zooming and panning of mermaid diagrams in the Packaging guidelines. (@bjlittle)
#1860: Disabled zooming and panning of mermaid diagrams in the Packaging guidelines. (@bjlittle)
#1908: Enabled sphinx-autoapi documentation of special-members (aka dunder methods). (@bjlittle)
#1912: Added the icon in the primary sidebar as a navigation convenience to the pyvista documentation. (@bjlittle)
#1931, #1932: Added the geovista badge as a shields.io endpoint asset. (@bjlittle)
#1936: Added the Community reference section. (@bjlittle)
#1941: Reformatted the community Third-Party Packages as a table for readability. (@bjlittle)
#1945: Added the community Publications section with a bibliography to reference scientific publications using geovista. (@bjlittle)
#1960: Applied colour Branding to the Font Awesome icons. (@bjlittle)
#1962: Completed first and second level title Font Awesome icon coverage. (@bjlittle)
#2033: Added the Plotter Extraction gallery example. (@bjlittle)
#2035: Updated the scalar-bar formatting for README.md and gallery point-cloud and DYNAMICO examples. (@bjlittle)
#2082: Added rebranded logo to README.md. (@bjlittle)
#2114: Added rebranded Logo section to the contributor guidelines. (@bjlittle)
#2117: Added Badge section to the contributor guidelines. (@bjlittle)
#2164: Added the new version sphinx-tags category. (@bjlittle)
#2178: Added the experimental 🧪 tag for highlighting experimental features and content. (@bjlittle)
#2201: Create a sitemap.xml only for the stable version of the documentation on readthedocs to improve Search Engine Optimization and discoverability. (@bjlittle)
#2251: Added Installation section tab synchronization. (@bjlittle)
#2255: Used the wurlitzer IPython extension to remove third-party diagnostic output from the rendered myst-nb tutorial. (@bjlittle)
#2276: Adopted sphinx-llms-txt to generate Large Language Model (LLM) friendly Markdown summaries of the documentation. (@bjlittle)
#2307: Added the custom sphinx readingtime directive to automatically estimate the audience reading time of a page and render a branded banner. (@bjlittle)
#2312: Added the Sphinx Directives section to the contributor guidelines. (@bjlittle)
#2313: Added support for the optional words-per-minute argument to the custom sphinx readingtime directive. (@bjlittle)
#987: Updated the Region Manifold Extraction tutorial to correct typos and add a cross-reference to pyvista.DataSetFilters.select_enclosed_points(). (@bjlittle)
#994: Adopted the standard of naming the plotter as p throughout documentation, docs-strings and examples. (@bjlittle)

💼 Internal#

#1036: Adjusted the number of contributors rendered per line to better suit reduced footprint on mobile platforms. (@bjlittle)
#1040: Adopt nodefaults to explicitly ignore the conda defaults channel when building the conda lock files. (@bjlittle)
#1050: Fixed typos and extended the list of files to skip with codespell. (@bjlittle)
#1075: Applied fix to avoid breaking change behaviour to code coverage upload, as introduced by the actions/upload-artifact v4.4.0 Action. (@bjlittle)
#1076: Introduced SECURITY.md. (@bjlittle)
#1081: Added missing concurrency to Actions. (@bjlittle)
#1082: Added ci-changelog Action to perform quality assurance on pull-request changelog news fragment/s. Closes #1031. (@bjlittle)
#1087: Reduced the all-contributors image size for better rendering on mobile platforms. (@bjlittle)
#1090: Report to the console by default for the ci-changelog Action. (@bjlittle)
#1091: Use SHA checksums for 3rd party Action versions. (@bjlittle)
#1094: Add the skip-changelog label to dependabot and ci-locks Action generated pull-requests. (@bjlittle)
#1120: Removed technical debt by migrating builtin open() usage to pathlib.Path.open() since enforcing SPEC-0 minimum python>=3.11 support. (@bjlittle)
#1121: Updated dependabot configuration to include composite actions. (@bjlittle)
#1133: Merged back 0.5.x release feature branch into main for 0.5.2. (@bjlittle)
#1136: Changed the frequency of the ci-locks Action cron to be every 2nd day to assist with earlier detection of breaking regressions in package dependencies, see #1131. (@bjlittle)
#1137: Removed Action duplication by migrating common job level defaults definitions to the workflow level. (@bjlittle)
#1138: Added ci-locks-test Action to assist with early detection of breaking regressions in package dependencies by running nightly tests against the latest resolved conda-lock environment. (@bjlittle)
#1139: Added lock file artifact upload for ci-locks-test Action to allow contributor reproducibility of any regression behaviour. (@bjlittle)
#1141: Configured setup-miniconda Action to avoid using the defaults channel. (@bjlittle)
#1144: Refactored Preference enums to use enum.StrEnum and enum.auto as py311 is now the minimum supported distribution, see #1118. (@bjlittle)
#1155: Reverted use of the jwalton/gh-find-current-pr Action within the ci-changelog Action. (@bjlittle)
#1158: Added ci-tests-pypi Action to assist with early detection of breaking regressions in package dependencies by running nightly tests against the latest resolved PyPI environment. (@bjlittle)
#1174: Merged back 0.5.x release feature branch into main for 0.5.3. Closes #1156. (@bjlittle)
#1219: Avoid using a pyvista private attribute when gathering active scalars information. (@user27182)
#1274: Removed a __all__ duplicate entry in geovista.pantry.data. (@HGWright)
#1318: Added a py.typed file in compliance with PEP 561. (@trexfeathers)
#1398: Migrated from sphinx-linkcheck builder to cron activated lychee Action. The link check workflow is no longer performed as part of a pull-request. (@bjlittle)
#1409: Added missing optional packages h3-py and rasterio to the geovista.report. (@bjlittle)
#1411: Added https://earthexplorer.usgs.gov/ to the list of URLs ignored by the lychee Action. Closes #1410. (@bjlittle)
#1438: Enabled caching and updated the list of URLs ignored by the lychee Action. Closes #1435. (@bjlittle)
#1516: Dropped use of deprecated ActiveArrayInfoTuple in the geovista.core. (@bjlitte)
#1547: Enforced an open-pull-request-limit for automated dependabot generated pull-requests. (@bjlittle)
#1564: Included trame-common package to the scooby geovista.report.Report. (@bjlittle)
#1597: Added nodefaults channel to lock2yaml template. (@bjlittle)
#1750: Dropped support for py311 as recommended by SPEC-0. (@bjlittle)
#1754: Configured the infrastructure to support unit test and documentation test image caching using pytest-pyvista. (@bjlittle)
#1777: Added ci-tests-docs Action to perform pytest-pyvista documentation image testing of pyvista-plot directive static scenes. (@bjlittle)
#1780: Added artifact upload of failed documentation test images for the ci-tests-docs Action. (@bjlittle)
#1850: Adopted explicit default permissions for Actions. (@bjlittle)
#1901: Endeavour to provision a community readable pooch.Pooch cache. (@bjlittle)
#1911: Updated ci-tests-lock and ci-tests-pypi Actions to capture and upload failed image unit tests as artifacts. (@bjlittle)
#1929: Added README.md light/dark theme support for our Star History Chart. (@bjlittle)
#1958: Applied consistent formatting to our labels. (@bjlittle)
#1997: Relaxed the regex checking for the existence of an author in new changelog fragments. (@ukmo-ccbunney)
#2110: Tidied the CLI entry-point to always route through geovista.__main__ and support direct script invocation. (@bjlittle)
#2179: Enabled generation of a generic conda environment YAML file that tracks the latest supported distribution of python. (@bjlittle)
#2247: Dropped the use of pyvista.start_xvfb when building the documentation. (@bjlittle)
#989: Added adRise/update-pr-branch Action to automatically update stale auto-merge pull-requests. (@tkoyama010)
#996: Enabled require_passed_checks for adRise/update-pr-branch Action. (@bjlittle)
#999: Merged back 0.5.x release feature branch into main for 0.5.1. (@bjlittle)

🌱 Community#

#1007: Added @wx4stg as a contributor for ideas and promotion. (@tkoyama010)
#1011: Added @tkoyama010 as a contributor for promotion. (@tkoyama010)
#1032: Added @berndbecker as a contributor for ideas. (@bjlittle)
#1034: Opened the doors to the 🍬 Candy Store, a community space on GH Discussions to openly share and promote how geovista is being used. (@bjlittle)
#1035: Added @bjlittle as a contributor for promotion. (@tkoyama010)
#1037: Added @dennissergeev as a contributor for talk. (@bjlittle)
#1044, #1046: Added @sit23 as a contributor for example and video. (@tkoyama010)
#1045: Added the Awesome badge and registered goevista with Awesome Open Geoscience for promotion within the Earth Science community. (@tkoyama010)
#1047: Added @tkoyama010 as a contributor for mentoring. (@tkoyama010)
#1086: Added @bjlittle as a contributor for security. (@tkoyama010)
#1088: Added @sit23 as a contributor for promotion. (@bjlittle)
#1095: Added @bjlittle as a contributor for ideas. (@tkoyama010)
#1097: Congratulations to @ukmo-ccbunney who became a geovista core contributor. (@bjlittle)
#1203, #1209: “So long X, and thanks for all the fish”. Migrated to Bluesky. (@bjlittle)
#1220: Added @user27182 as a contributor for code. (@tkoyama010)
#1236: Added @kuchaale as a contributor for example. (@bjlittle)
#1237: Added @dennissergeev as a contributor for example. (@bjlittle)
#1250: Added @tkoyama010 as a contributor for security. (@bjlittle)
#1271: Added @HGWright as a contributor for review. (@bjlittle)
#1275: Added @HGWright as a contributor for code. (@bjlittle)
#1290: Added @ESadek-MO as a contributor for code, example, and data. (@bjlittle)
#1296: Added @ESadek-MO as a contributor for review. (@bjlittle)
#1311: Added @HGWright as a contributor for data and example. (@bjlittle)
#1437: Added @beroda as a contributor for bug, code and test. (@bjlittle)
#1670: Added @rcomer as a contributor for review. (@bjlittle)
#1738: Added @changliao1025 as a contributor for bug. (@bjlittle)
#1772: Added @mo-ijadav as a contributor for promotion. (@bjlittle)
#1862: Added @DanCopsey as a contributor for promotion and tool. (@bjlittle)
#1870: Added @RobWatersMet as a contributor for ideas. (@bjlittle)
#1873: Added @RobWatersMet as a contributor for code and test. (@bjlittle)
#1939: Added @Erin-1919 as a contributor for promotion. (@bjlittle)
#1940: Added aeolus package to the Community section. (@dennissergeev)
#1942: Added @dennissergeev as a contributor for documentation. (@bjlittle)
#1949: Added ngview package to the Community section. (@DanCopsey)
#1950: Added @DanCopsey as a contributor for documentation. (@bjlittle)
#1957: Added @tkknight as a contributor for bug and code. (@bjlittle)
#1998: Added @ukmo-ccbunney as a contributor for code and documentation. (@bjlittle)
#2004: Added @scout-the-beagle 🐶 as contributor for audio, ideas, mentoring, question, and security. (@bjlittle)
#2019: Added @ukmo-ccbunney as a contributor for bug. (@bjlittle)
#2029: Added @aspyk as a contributor for bug. (@bjlittle)
#2120: Updated the Contributor Covenant Code of Conduct from version 2.1 to version 3.0. (@tkoyama010)
#2168: Added @pp-mo as a contributor for code, data, example, talk, test, and promotion. (@bjlittle)
#2170: Added @ukmo-ccbunney as a contributor for talk and promotion. (@bjlittle)
#988: Added @bjlittle as a contributor for tutorial. (@tkoyama010)
#993: Added @Hedonical as a contributor for ideas. (@tkoyama010)

🛠️ Contributor Infrastructure#

#1005: Added the ci-joss workflow to automatically compile our JOSS paper from Markdown to PDF. (@tkoyama010)
#1008: Enabled the nbQA pre-commit hook to ensure tutorial jupyter notebook quality assurance against ruff rule compliance. (@bjlittle)
#1064: Dropped nbQA pre-commit hook, as ruff lints and formats Jupyter notebooks by default from v0.6.0. (@tkoyama010)
#1124: Dropped the use of tox to render lock file updates within the ci-locks Action due to incompatibilites between the pinned tox-conda plugin and the modern runner environment. (@bjlittle)
#1146: Optimised the documentation building workflow by providing control of whether tutorial jupyter notebook code cells are executed. By default, code cells will only be executed when building the documentation with either the make html or make html-tutorial commands. Closes #1030. (@bjlittle)
#1147: Adopted caching of tutorial jupyter notebook outputs when building the documentation. The cache will only be cleared with either the make clean-cache or make clean-all commands. The make clean command will not clear the cache. Closes #1018. (@bjlittle)
#1160: Updated dependabot to orchestrate updates for the pip package-ecosystem. (@bjlittle)
#1162: Triggered the ci-tests-pypi Action on a pull_request event in order to provide test coverage of dependabot package updates. (@bjlittle)
#1177: Extended ci-locks Action to support py313. (@bjlittle)
#1207: Added taplo pre-commit hook to format and sort toml files. (@tkoyama010)
#1211: Complied with ruff flake8-boolean-trap (FBT) and flake8-todos (TD) rules. (@bjlittle)
#1212: Complied with ruff flake8-annotations (ANN) rules. (@bjlittle)
#1214: Complied with ruff pylint-refactor (PLR) rules. (@bjlittle)
#1215: Complied with ruff pylint-warning (PLW) rules. (@bjlittle)
#1216: Complied with ruff flake8-self (SLF) rules. (@bjlittle)
#1217: Dropped the use of .ruff.toml to capture outstanding ruff rule exceptions. Non-compliances have been addressed or moved to the pyproject.toml. (@bjlittle)
#1225: Dropped sort-all pre-commit hook, as ruff 0.8.0 stabilized the unsorted-dunder-all (RUF022) preview rule. (@bjlittle)
#1227: Dropped the use of setup.py, given the already configured PEP 517 build-backend with setuptools. (@bjlittle)
#1241: Dropped use of latest tag and explicitly pinned to ubuntu-22.04 Action runner-image. (@bjlittle)
#1254: Updated the ci-label Action to migrate from nep-29 to SPEC-0. (@bjlittle)
#1257: Enabled the zizmor pre-commit hook for security static analysis of Actions. Closes #1248. (@tkoyama010)
#1277: Rationalised the use of sphinx cross-references. (@bjlittle)
#1279: Restructured the Contributing guidelines. (@bjlittle)
#1298: Added developer Documentation guidelines. (@bjlittle)
#1304: Added sphinx cross-references to the Examples. (@bjlittle)
#1313: Mirrored the pyvista PyPI package management strategy by adopting a rolling latest maximum pin, and rely on dependabot to orchestrate ecosystem updates. (@bjlittle)
#1317: Detect missing author :user: directive within a changelog news fragment. (@bjlittle)
#1324: Configured the conda-remove-defaults = true option for the setup-miniconda Action. (@bjlittle)
#1325: Converted pypi-publish Action options from snake_case to kebab-case. (@bjlittle)
#1356: Extended the validate-project pre-commit hook to use additional schema compliance checks for pyproject.toml. (@bjlittle)
#1388: Updated the testing theme background, font and colormap. (@bjlittle)
#1414: Updated the pygrep-hooks pre-commit hook to include additional coverage. (@bjlittle)
#1458: Enabled sphinx-lint pre-commit hook to quality check .rst and .py files. (@bjlittle)
#1495: Consolidated cartopy-cache composite Action to use a single common cache for all Actions. (@bjlittle)
#1497: Created the PyPI optional dependencies devs group and renamed the pixi 🧚 feature dev to devs. Also included the zizmor package to devs. (@bjlittle)
#1500: Migrated to actions/create-github-app-token Action from tibdex/github-app-token Action. (@bjlittle)
#1509: Adopted publishing binary wheels to PyPI with a Trusted Publisher via the OpenID Connect (OIDC) Standard. (@bjlittle)
#1513: Resolved various ruff ==0.12.0 rule non-compliances. (@bjlittle)
#1567: Created the PyPI optional dependencies all group. (@bjlittle)
#1578: Added the pixi 🧚 workflow tasks clean-all, clean-cache and doctest for the docs feature. (@bjlittle)
#1585: Added the pixi 🧚 workflow tasks test and test-clean for the test feature. (@bjlittle)
#1595: Migrated readthedocs to build with pixi 🧚. (@bjlittle)
#1609: Added the direnv .envrc configuration file to .gitignore. (@bjlittle)
#1612: Added developer Cross-References guidelines. (@bjlittle)
#1620: Updated the ci-label Action to auto-label pixi branches. (@bjlittle)
#1621: Added the latest supported distribution of python to the pixi 🧚 default environment. (@bjlittle)
#1634: Added developer Packaging guidelines. (@bjlittle)
#1655: Added developer Branding guidelines. (@bjlittle)
#1668: Enabled ruff flake8-copyright preview rule (CPY001) to enforce file copyright preamble. (@bjlittle)
#1671: Added developer Copyright & License guidelines. (@bjlittle)
#1703: Added developer Tagging guidelines. (@bjlittle)
#1718: Updated developer Packaging guidelines. (@bjlittle)
#1727: Updated developer Documentation guidelines. (@bjlittle)
#1770: Added the html-docstring-inline task as a documentation Build option to build and render only docstring and inline images and scenes within the documentation. (@bjlittle)
#1771: Building documentation will now automatically check, verify and create the docs/image_cache symbolic link the appropriate pooch.Pooch documentation reference test images cache. (@bjlittle)
#1776: Added the doc-images pixi 🧚 task to the docs feature which performs documentation image testing of pyvista-plot directive static scenes. (@bjlittle)
#1783: Rebranded the doc-images pixi 🧚 task as tests-docs. Also added Pixi Tasks to the Packaging guidelines. (@bjlittle)
#1787: Added descriptions to the pixi 🧚 tasks, available via the pixi task list command line interface (CLI). (@bjlittle)
#1810: Added embedded mermaid graphs of pixi 🧚 solve-group environment hierarchies to the Packaging guidelines. (@bjlittle)
#1820: Reduced the dependabot schedule interval for the pip ecosystem to be daily now that the cooldown period is configured. (@bjlittle)
#1824: Added @geovista-bot as a generic user independent codeowner. (@bjlittle)
#1830: Introduced the @geovista-bot auto-approve workflow to approve pull-requests by trusted contributors and thus permitting elevated main branch protection by enforcing CODEOWNERS reviews. (@bjlittle)
#1847: Reduced max-concurrency to a single thread when performing URL linkchecks with the lychee Action. This is to avoid exceptions caused by sporadic server-side connection resets. (@bjlittle)
#1858: Updated the Cross-References guidelines to include the use of the :name: option for a figure or table, and recommended the :alt: option for figure accessibility best practice. (@bjlittle)
#1876: Added developer Testing guidelines. (@bjlittle)
#1883: Relaxed dependabot to ignore patch releases for the PyPI ecosystem in order to reduce the update cadence and closer align to the default pixi 🧚 major/minor maximum capping-pin strategy for explicit dependency versions. (@bjlittle)
#1890: Capture failed image unit tests for the ci-tests Action as a workflow artifact, and also when using the tests-unit pixi 🧚 task. (@bjlittle)
#1965: Added the ci-first-contribution Action to automatically acknowledge and welcome first time Issue and Pull-Request contributions from the community. (@bjlittle)
#2008: Extended the @geovista-bot auto-approve workflow behaviour to allow trusted collaborators to request approval for bot sourced pull-requests. (@bjlittle)
#2020: Added developer Codecraft 🚧 maintenance guidelines. (@bjlittle)
#2061: Added developer Generative AI guidelines. (@bjlittle)

🧰 Miscellaneous#

#1386: Added the clouds_stratify CLI example. (@bjlittle)
#1959: Reverted dimensionality reference usage from n-D to nD. (@bjlittle)