From c1093379ea3c646bb39f8ede79e483a26e648562 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Mon, 16 Nov 2026 15:02:52 +0800 Subject: [PATCH 01/12] Add entry in doc/_static/version_switch.js for documentation switcher --- doc/_static/version_switch.js | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/_static/version_switch.js b/doc/_static/version_switch.js index 29c59546cf3..5839108d449 100644 --- a/doc/_static/version_switch.js +++ b/doc/_static/version_switch.js @@ -12,6 +12,7 @@ var all_versions = { 'latest': 'latest', 'dev': 'dev', + 'v0.20.0': 'v0.20.0', 'v0.19.0': 'v0.19.0', 'v0.18.0': 'v0.18.0', 'v0.17.0': 'v0.17.0', From 32ef61ec7129fa0b6a27f88f6d5a4d45bebb90db Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Mon, 16 Nov 2026 15:07:04 +0800 Subject: [PATCH 02/12] Add the version to the compatibility table doc/minversions.md --- doc/minversions.md | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/minversions.md b/doc/minversions.md index 32968c8353d..d1eddcd6c12 100644 --- a/doc/minversions.md +++ b/doc/minversions.md @@ -47,6 +47,7 @@ compatibility reasons. | PyGMT Version | Documentation | GMT | Python | NumPy | pandas | xarray | |---|---|---|---|---|---|---| | [Dev][]* | , [HTML+ZIP](doc:dev/pygmt-docs.zip), [PDF](doc:dev/pygmt-docs.pdf) | {{ requires.gmt }} | {{ requires.python }} | {{ requires.numpy }} | {{ requires.pandas }} | {{ requires.xarray }} | +| | , , | >=6.5.0 | >=3.12 | >=2.2 | >=2.3 | >=2024.10 | | | , , | >=6.5.0 | >=3.12 | >=2.1 | >=2.3 | >=2024.7 | | | , , | >=6.5.0 | >=3.12 | >=2.0 | >=2.2 | >=2024.5 | | | , , | >=6.5.0 | >=3.11 | >=1.26 | >=2.2 | >=2023.10 | From cd303c0c4d84cc2d2f812a9cb4fd0494545513b9 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Mon, 16 Nov 2026 15:11:44 +0800 Subject: [PATCH 03/12] Update citation information CITATION.cff and BibTeX in doc/citing.md --- CITATION.cff | 6 +++--- doc/citing.md | 12 ++++++------ 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/CITATION.cff b/CITATION.cff index 34582c35ba4..4379b9eb55b 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -83,11 +83,11 @@ authors: orcid: 'https://orcid.org/0000-0001-5708-7336' identifiers: - type: doi - value: 10.5281/zenodo.19398871 + value: 10.5281/zenodo.24271916 repository-code: 'https://github.com/GenericMappingTools/pygmt' license: BSD-3-Clause -version: 0.19.0 -date-released: '2026-07-07' +version: 0.20.0 +date-released: '2026-11-22' preferred-citation: type: article authors: diff --git a/doc/citing.md b/doc/citing.md index 2fc3c32f24d..56ce1d7fb2c 100644 --- a/doc/citing.md +++ b/doc/citing.md @@ -30,9 +30,9 @@ The BibTeX entry for the PyGMT paper is: url = {https://doi.org/10.1029/2026GC013105}, } ``` -The BibTeX entry for the latest Zenodo archive, i.e., release 0.19.0, of the PyGMT software is: +The BibTeX entry for the latest Zenodo archive, i.e., release 0.20.0, of the PyGMT software is: ``` -@software{pygmt_2026_19398871, +@software{pygmt_2026_24271916, author = {Tian, Dongdong and Leong, Wei Ji and Fröhlich, Yvonne and @@ -53,12 +53,12 @@ The BibTeX entry for the latest Zenodo archive, i.e., release 0.19.0, of the PyG Uieda, Leonardo and Wessel, Paul}, title = {{PyGMT: A Python interface for the Generic Mapping Tools}}, - month = jul, + month = nov, year = 2026, publisher = {Zenodo}, - version = {0.19.0}, - doi = {10.5281/zenodo.19398871}, - url = {https://doi.org/10.5281/zenodo.19398871} + version = {0.20.0}, + doi = {10.5281/zenodo.24271916}, + url = {https://doi.org/10.5281/zenodo.24271916} } ``` To cite a specific version of PyGMT, go to the [Zenodo archive](https://doi.org/10.5281/zenodo.3781524), From 260326946cd49f75b27e531836ee3b211f300cbb Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Mon, 16 Nov 2026 15:13:50 +0800 Subject: [PATCH 04/12] Copy the draft release note from the release page --- doc/changes.md | 103 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 103 insertions(+) diff --git a/doc/changes.md b/doc/changes.md index b8c5c6f6faf..ab9658480b7 100644 --- a/doc/changes.md +++ b/doc/changes.md @@ -1,5 +1,108 @@ # Changelog +## Release v0.20.0 (20YY/MM/DD) + +[![Digital Object Identifier for PyGMT v0.20.0](https://img.shields.io/badge/DOI-10.5281/zenodo.3781524-blue)](https://doi.org/10.5281/zenodo.3781524) + +### Highlights + +* + +### Enhancements + +* BREAKING: Figure.coast: Add parameter river_lakes for setting fills of river-lakes separately ([#4376](https://github.com/GenericMappingTools/pygmt/pull/4376)) +* Figure.directional_rose: Add parameter 'upright_labels' to force readable labels for rotated projections ([#4867](https://github.com/GenericMappingTools/pygmt/pull/4867)) +* Figure.histogram: Add parameter 'out_range' to handle extreme values and deprecate parameter 'extreme' ([#4882](https://github.com/GenericMappingTools/pygmt/pull/4882)) +* Figure.histogram: Add parameters to annote bars and deprecate parameter 'annotate' ([#4895](https://github.com/GenericMappingTools/pygmt/pull/4895)) +* Figure.histogram: Add the parameter 'weights' for weighting data ([#4890](https://github.com/GenericMappingTools/pygmt/pull/4890)) +* Figure.histogram: Improve parameters 'distribution' and 'distribution_pen' to draw distribution curves ([#4894](https://github.com/GenericMappingTools/pygmt/pull/4894)) +* Figure.histogram: Improved syntax for filling bars by position/value ([#4886](https://github.com/GenericMappingTools/pygmt/pull/4886)) +* Figure.histogram: Let parameter 'cumulative' support Pythonic arguments ([#4881](https://github.com/GenericMappingTools/pygmt/pull/4881)) +* Figure.histogram: Let the parameter 'series' accept a sequence ([#4899](https://github.com/GenericMappingTools/pygmt/pull/4899)) +* Figure.histogram: Support Pythonic arguments for the 'histtype' parameter ([#4912](https://github.com/GenericMappingTools/pygmt/pull/4912)) +* Figure.hlines/Figure.vlines: Add the parameter 'panel' to specify the subplot panel ([#4892](https://github.com/GenericMappingTools/pygmt/pull/4892)) +* Figure.image: Add parameter fgcolor/bgcolor/transparent_color and deprecate bitcolor [Will be removed in 0.24.0] ([#4872](https://github.com/GenericMappingTools/pygmt/pull/4872)) +* pygmt.blockmean/blockmedian/blockmode: Add the center parameter (-C) ([#4780](https://github.com/GenericMappingTools/pygmt/pull/4780)) + +### Deprecations + +* Figure.grdview: Remove the deprecated parameters '*pen'/'drapegrid' ([#4830](https://github.com/GenericMappingTools/pygmt/pull/4830)) +* Figure.grdcontour: Remove the deprecated 'interval' parameter [Deprecated since v0.12.0] ([#4764](https://github.com/GenericMappingTools/pygmt/pull/4764)) +* Figure.histogram: Add parameter 'out_range' to handle extreme values and deprecate parameter 'extreme' ([#4882](https://github.com/GenericMappingTools/pygmt/pull/4882)) +* Figure.histogram: Add parameters to annote bars and deprecate parameter 'annotate' ([#4895](https://github.com/GenericMappingTools/pygmt/pull/4895)) +* Figure.histogram: Remove the deprecated parameter barwidth [Deprecated since 0.18.0] ([#4827](https://github.com/GenericMappingTools/pygmt/pull/4827)) +* Figure.image: Add parameter fgcolor/bgcolor/transparent_color and deprecate bitcolor [Will be removed in 0.24.0] ([#4872](https://github.com/GenericMappingTools/pygmt/pull/4872)) +* Figure.inset: Remove deprecated parameter margin [Deprecated since 0.18.0] ([#4826](https://github.com/GenericMappingTools/pygmt/pull/4826)) +* Figure.meca: Remove the deprecated parameters 'label'/'*fill' ([#4829](https://github.com/GenericMappingTools/pygmt/pull/4829)) +* Figure.velo: Remove deprecated parameter 'uncertaintyfill' [Deprecated since 0.18.0] ([#4835](https://github.com/GenericMappingTools/pygmt/pull/4835)) +* Figure.wiggle: Remove the deprecated parameters 'fillpositive'/'fillnegative' [Deprecated since 0.18.0] ([#4831](https://github.com/GenericMappingTools/pygmt/pull/4831)) +* Session.virtualfile_in: Remove the deprecated parameter 'required_z'/'required_data'/'extra_arrays' [Deprecated since 0.16.0] ([#4828](https://github.com/GenericMappingTools/pygmt/pull/4828)) +* pygmt.grdfill: Remove the deprecated '*fill' parameters [Deprecated since 0.18.0] ([#4836](https://github.com/GenericMappingTools/pygmt/pull/4836)) +* pygmt.grdlandmask: Remove the deprecated parameters 'maskvalue'/'bordervalues' [Deprecated since 0.18.0] ([#4833](https://github.com/GenericMappingTools/pygmt/pull/4833)) +* pygmt.load_dataarray: Remove the deprecated function [Deprecated since v0.16.0] ([#4837](https://github.com/GenericMappingTools/pygmt/pull/4837)) +* pygmt.select: Remove the deprecated parameters mask/gridmask [Deprecated since 0.18.0] ([#4825](https://github.com/GenericMappingTools/pygmt/pull/4825)) +* pygmt.surface: Remove the deprecated parameter 'maxradius' [Deprecated since 0.18.0] ([#4832](https://github.com/GenericMappingTools/pygmt/pull/4832)) +* pygmt.x2sys_cross: Remove the deprecated parameter 'trackvalues' [Deprecated since 0.18.0] ([#4834](https://github.com/GenericMappingTools/pygmt/pull/4834)) + +### Bug Fixes + +* Figure.directional_rose/Figure.magnetic_rose: Fix compatibility with upcoming GMT 6.7.0 ([#4729](https://github.com/GenericMappingTools/pygmt/pull/4729)) +* Figure.grdview: Fix the default z-plane with GMT 6.7.0 ([#4804](https://github.com/GenericMappingTools/pygmt/pull/4804)) +* Figure.solar: Fix the bug that terminator datetime doesn't support fractional timezone offsets ([#4916](https://github.com/GenericMappingTools/pygmt/pull/4916)) +* Figure.tilemap/pygmt.datasets.tile_map: Set User-Agent to avoid blocked access to OSM tile server ([#4816](https://github.com/GenericMappingTools/pygmt/pull/4816)) +* Fix sequence_join treating any string with a space as a datetime ([#4961](https://github.com/GenericMappingTools/pygmt/pull/4961)) +* pygmt.project: Fix the bug that passing x/y/z is not allowed ([#4866](https://github.com/GenericMappingTools/pygmt/pull/4866)) + +### Documentation + +* Add a separate documentation for supported plot and distance units ([#4359](https://github.com/GenericMappingTools/pygmt/pull/4359)) +* Add blockmedian and surface gallery example ([#4771](https://github.com/GenericMappingTools/pygmt/pull/4771)) +* DOC: Demonstrate straight_line in Plotting Lines tutorial ([#4971](https://github.com/GenericMappingTools/pygmt/pull/4971)) +* DOC: Document the supported array dtypes ([#3582](https://github.com/GenericMappingTools/pygmt/pull/3582)) +* Figuer.ternary: Add an inline example ([#4931](https://github.com/GenericMappingTools/pygmt/pull/4931)) +* Figure.contour: Add an inline example ([#4934](https://github.com/GenericMappingTools/pygmt/pull/4934)) +* Figure.legend: Add an inline example ([#4930](https://github.com/GenericMappingTools/pygmt/pull/4930)) +* Figure.meca: Add an inline example ([#4929](https://github.com/GenericMappingTools/pygmt/pull/4929)) +* Figure.plot3d: Add an inline example ([#4933](https://github.com/GenericMappingTools/pygmt/pull/4933)) +* Figure.plot: Add an inline example ([#4932](https://github.com/GenericMappingTools/pygmt/pull/4932)) +* Figure.rose: Add inline example ([#4945](https://github.com/GenericMappingTools/pygmt/pull/4945)) +* Figure.subplot: Add an inline example ([#4938](https://github.com/GenericMappingTools/pygmt/pull/4938)) +* Figure.text: Add an inline example ([#4937](https://github.com/GenericMappingTools/pygmt/pull/4937)) +* Figure.tilemap: Add two inline examples ([#4928](https://github.com/GenericMappingTools/pygmt/pull/4928)) +* Figure.velo: Add inline example ([#4944](https://github.com/GenericMappingTools/pygmt/pull/4944)) +* Figure.wiggle: Add an inline example ([#4936](https://github.com/GenericMappingTools/pygmt/pull/4936)) +* Improve the Cartesian histogram tutorial ([#4965](https://github.com/GenericMappingTools/pygmt/pull/4965)) +* Stop recommending mamba in installation guides and error messages ([#4766](https://github.com/GenericMappingTools/pygmt/pull/4766)) + +### Maintenance + +* Add support for Python 3.15 ([#4949](https://github.com/GenericMappingTools/pygmt/pull/4949)) +* CI: Bump the GMT version in CI to 6.7.0 ([#4802](https://github.com/GenericMappingTools/pygmt/pull/4802)) +* Follow Semantic Versioning and remove the leading v from version string ([#4838](https://github.com/GenericMappingTools/pygmt/pull/4838)) +* Migrate baseline images from DVC to Git LFS ([#4740](https://github.com/GenericMappingTools/pygmt/pull/4740)) +* PEP770: Package SBOM in CycloneDX format into wheels ([#4975](https://github.com/GenericMappingTools/pygmt/pull/4975)) +* Ruff: Enable RUF105 'noqa-comments' and bump to Ruff>=0.15.22 ([#4761](https://github.com/GenericMappingTools/pygmt/pull/4761)) +* Ruff: Enable RUF106 (rule-codes-in-suppression-comments) ([#4772](https://github.com/GenericMappingTools/pygmt/pull/4772)) +* SPEC 0: Bump minimum supported version to NumPy 2.2 and xarray 2024.10 ([#4883](https://github.com/GenericMappingTools/pygmt/pull/4883)) + +**Full Changelog**: + +**Contributors**: +[@Aayush7788](https://github.com/Aayush7788), [@AisunZa](https://github.com/AisunZa), [@floze](https://github.com/floze)-the-genius, [@Johnkothapalli](https://github.com/Johnkothapalli), [@manduinca](https://github.com/manduinca), [@Mohit](https://github.com/Mohit)-Ak, [Dongdong Tian](https://github.com/seisman), [@utkarshalpha](https://github.com/utkarshalpha), [Wei Ji Leong](https://github.com/weiji14), [@yogirajh007](https://github.com/yogirajh007), [@yousizaitianqiong](https://github.com/yousizaitianqiong) and [Yvonne Fröhlich](https://github.com/yvonnefroehlich) + +**New Contributors**: +* [@utkarshalpha](https://github.com/utkarshalpha) made their first contribution in #4766 +* [@Aayush7788](https://github.com/Aayush7788) made their first contribution in #4780 +* [@floze](https://github.com/floze)-the-genius made their first contribution in #4826 +* [@Johnkothapalli](https://github.com/Johnkothapalli) made their first contribution in #4827 +* [@yousizaitianqiong](https://github.com/yousizaitianqiong) made their first contribution in #4835 +* [@yogirajh007](https://github.com/yogirajh007) made their first contribution in #4837 +* [@Mohit](https://github.com/Mohit)-Ak made their first contribution in #4961 +* [@AisunZa](https://github.com/AisunZa) made their first contribution in #4971 +* [@manduinca](https://github.com/manduinca) made their first contribution in #4965 + +--- + ## Release v0.19.0 (2026/07/07) [![Digital Object Identifier for PyGMT v0.19.0](https://img.shields.io/badge/DOI-10.5281/zenodo.19398871-blue)](https://doi.org/10.5281/zenodo.19398871) From 33946ac11c91873879ffb254724b0aab76d152eb Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Mon, 16 Nov 2026 15:17:49 +0800 Subject: [PATCH 05/12] Update release date, doi and contributors in the changelog --- doc/changes.md | 35 +++++++++++++++++++++++------------ 1 file changed, 23 insertions(+), 12 deletions(-) diff --git a/doc/changes.md b/doc/changes.md index ab9658480b7..1bd3bcf6e8a 100644 --- a/doc/changes.md +++ b/doc/changes.md @@ -1,8 +1,8 @@ # Changelog -## Release v0.20.0 (20YY/MM/DD) +## Release v0.20.0 (2026/11/22) -[![Digital Object Identifier for PyGMT v0.20.0](https://img.shields.io/badge/DOI-10.5281/zenodo.3781524-blue)](https://doi.org/10.5281/zenodo.3781524) +[![Digital Object Identifier for PyGMT v0.20.0](https://img.shields.io/badge/DOI-10.5281/zenodo.24271916-blue)](https://doi.org/10.5281/zenodo.24271916) ### Highlights @@ -88,18 +88,29 @@ **Full Changelog**: **Contributors**: -[@Aayush7788](https://github.com/Aayush7788), [@AisunZa](https://github.com/AisunZa), [@floze](https://github.com/floze)-the-genius, [@Johnkothapalli](https://github.com/Johnkothapalli), [@manduinca](https://github.com/manduinca), [@Mohit](https://github.com/Mohit)-Ak, [Dongdong Tian](https://github.com/seisman), [@utkarshalpha](https://github.com/utkarshalpha), [Wei Ji Leong](https://github.com/weiji14), [@yogirajh007](https://github.com/yogirajh007), [@yousizaitianqiong](https://github.com/yousizaitianqiong) and [Yvonne Fröhlich](https://github.com/yvonnefroehlich) +[@Aayush7788](https://github.com/Aayush7788), +[@AisunZa](https://github.com/AisunZa), +[@floze](https://github.com/floze-the-genius), +[@Johnkothapalli](https://github.com/Johnkothapalli), +[@manduinca](https://github.com/manduinca), +[@Mohit](https://github.com/Mohit-Ak), +[Dongdong Tian](https://github.com/seisman), +[@utkarshalpha](https://github.com/utkarshalpha), +[Wei Ji Leong](https://github.com/weiji14), +[@yogirajh007](https://github.com/yogirajh007), +[@yousizaitianqiong](https://github.com/yousizaitianqiong), +[Yvonne Fröhlich](https://github.com/yvonnefroehlich) **New Contributors**: -* [@utkarshalpha](https://github.com/utkarshalpha) made their first contribution in #4766 -* [@Aayush7788](https://github.com/Aayush7788) made their first contribution in #4780 -* [@floze](https://github.com/floze)-the-genius made their first contribution in #4826 -* [@Johnkothapalli](https://github.com/Johnkothapalli) made their first contribution in #4827 -* [@yousizaitianqiong](https://github.com/yousizaitianqiong) made their first contribution in #4835 -* [@yogirajh007](https://github.com/yogirajh007) made their first contribution in #4837 -* [@Mohit](https://github.com/Mohit)-Ak made their first contribution in #4961 -* [@AisunZa](https://github.com/AisunZa) made their first contribution in #4971 -* [@manduinca](https://github.com/manduinca) made their first contribution in #4965 +[@utkarshalpha](https://github.com/utkarshalpha), +[@Aayush7788](https://github.com/Aayush7788), +[@floze](https://github.com/floze-the-genius), +[@Johnkothapalli](https://github.com/Johnkothapalli), +[@yousizaitianqiong](https://github.com/yousizaitianqiong), +[@yogirajh007](https://github.com/yogirajh007), +[@Mohit](https://github.com/Mohit-Ak), +[@AisunZa](https://github.com/AisunZa), +[@manduinca](https://github.com/manduinca) --- From 0dd4e9cf5cbd131e72641361e1c4e358dcaa4c38 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Mon, 16 Nov 2026 15:36:54 +0800 Subject: [PATCH 06/12] Add skipped contributors --- doc/changes.md | 31 ++++++++++++------------------- 1 file changed, 12 insertions(+), 19 deletions(-) diff --git a/doc/changes.md b/doc/changes.md index 1bd3bcf6e8a..63683e14037 100644 --- a/doc/changes.md +++ b/doc/changes.md @@ -88,29 +88,22 @@ **Full Changelog**: **Contributors**: -[@Aayush7788](https://github.com/Aayush7788), -[@AisunZa](https://github.com/AisunZa), -[@floze](https://github.com/floze-the-genius), -[@Johnkothapalli](https://github.com/Johnkothapalli), -[@manduinca](https://github.com/manduinca), -[@Mohit](https://github.com/Mohit-Ak), -[Dongdong Tian](https://github.com/seisman), -[@utkarshalpha](https://github.com/utkarshalpha), -[Wei Ji Leong](https://github.com/weiji14), -[@yogirajh007](https://github.com/yogirajh007), -[@yousizaitianqiong](https://github.com/yousizaitianqiong), +[Dongdong Tian](https://github.com/seisman), [Yvonne Fröhlich](https://github.com/yvonnefroehlich) - -**New Contributors**: -[@utkarshalpha](https://github.com/utkarshalpha), +[Wei Ji Leong](https://github.com/weiji14), +[Will Schlitzer](https://github.com/willschlitzer), +[Xingchen He](https://github.com/Chuan1937), [@Aayush7788](https://github.com/Aayush7788), +[@AisunZa](https://github.com/AisunZa), [@floze](https://github.com/floze-the-genius), -[@Johnkothapalli](https://github.com/Johnkothapalli), -[@yousizaitianqiong](https://github.com/yousizaitianqiong), +[@Johnkothapalli](https://github.com/Johnkothapalli), +[@manduinca](https://github.com/manduinca), +[@mmporong](https://github.com/mmporong), +[@Mohit](https://github.com/Mohit-Ak), +[@tashakaggarwal](https://github.com/tashakaggarwal), +[@utkarshalpha](https://github.com/utkarshalpha), [@yogirajh007](https://github.com/yogirajh007), -[@Mohit](https://github.com/Mohit-Ak), -[@AisunZa](https://github.com/AisunZa), -[@manduinca](https://github.com/manduinca) +[@yousizaitianqiong](https://github.com/yousizaitianqiong) --- From 98ed165b487ea3ace57c2e046421b2a90efb9660 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Mon, 16 Nov 2026 15:55:10 +0800 Subject: [PATCH 07/12] Fix GitHub handlers of two contributors --- doc/changes.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/changes.md b/doc/changes.md index 63683e14037..0616d21a0a8 100644 --- a/doc/changes.md +++ b/doc/changes.md @@ -95,11 +95,11 @@ [Xingchen He](https://github.com/Chuan1937), [@Aayush7788](https://github.com/Aayush7788), [@AisunZa](https://github.com/AisunZa), -[@floze](https://github.com/floze-the-genius), +[@floze-the-genius](https://github.com/floze-the-genius), [@Johnkothapalli](https://github.com/Johnkothapalli), [@manduinca](https://github.com/manduinca), [@mmporong](https://github.com/mmporong), -[@Mohit](https://github.com/Mohit-Ak), +[@Mohit-Ak](https://github.com/Mohit-Ak), [@tashakaggarwal](https://github.com/tashakaggarwal), [@utkarshalpha](https://github.com/utkarshalpha), [@yogirajh007](https://github.com/yogirajh007), From 4e4b0a91e819635390bf23c16368484eb5917fde Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Tue, 17 Nov 2026 10:20:08 +0800 Subject: [PATCH 08/12] Standarize changelog messages MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com> --- doc/changes.md | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/doc/changes.md b/doc/changes.md index 0616d21a0a8..1f8f271b0a6 100644 --- a/doc/changes.md +++ b/doc/changes.md @@ -10,37 +10,37 @@ ### Enhancements -* BREAKING: Figure.coast: Add parameter river_lakes for setting fills of river-lakes separately ([#4376](https://github.com/GenericMappingTools/pygmt/pull/4376)) +* BREAKING: Figure.coast: Add parameter 'river_lakes' for setting fills of river-lakes separately ([#4376](https://github.com/GenericMappingTools/pygmt/pull/4376)) * Figure.directional_rose: Add parameter 'upright_labels' to force readable labels for rotated projections ([#4867](https://github.com/GenericMappingTools/pygmt/pull/4867)) * Figure.histogram: Add parameter 'out_range' to handle extreme values and deprecate parameter 'extreme' ([#4882](https://github.com/GenericMappingTools/pygmt/pull/4882)) -* Figure.histogram: Add parameters to annote bars and deprecate parameter 'annotate' ([#4895](https://github.com/GenericMappingTools/pygmt/pull/4895)) +* Figure.histogram: Add parameters to annotate bars and deprecate parameter 'annotate' ([#4895](https://github.com/GenericMappingTools/pygmt/pull/4895)) * Figure.histogram: Add the parameter 'weights' for weighting data ([#4890](https://github.com/GenericMappingTools/pygmt/pull/4890)) * Figure.histogram: Improve parameters 'distribution' and 'distribution_pen' to draw distribution curves ([#4894](https://github.com/GenericMappingTools/pygmt/pull/4894)) * Figure.histogram: Improved syntax for filling bars by position/value ([#4886](https://github.com/GenericMappingTools/pygmt/pull/4886)) * Figure.histogram: Let parameter 'cumulative' support Pythonic arguments ([#4881](https://github.com/GenericMappingTools/pygmt/pull/4881)) * Figure.histogram: Let the parameter 'series' accept a sequence ([#4899](https://github.com/GenericMappingTools/pygmt/pull/4899)) -* Figure.histogram: Support Pythonic arguments for the 'histtype' parameter ([#4912](https://github.com/GenericMappingTools/pygmt/pull/4912)) +* Figure.histogram: Support Pythonic arguments for the parameter 'histtype' ([#4912](https://github.com/GenericMappingTools/pygmt/pull/4912)) * Figure.hlines/Figure.vlines: Add the parameter 'panel' to specify the subplot panel ([#4892](https://github.com/GenericMappingTools/pygmt/pull/4892)) -* Figure.image: Add parameter fgcolor/bgcolor/transparent_color and deprecate bitcolor [Will be removed in 0.24.0] ([#4872](https://github.com/GenericMappingTools/pygmt/pull/4872)) -* pygmt.blockmean/blockmedian/blockmode: Add the center parameter (-C) ([#4780](https://github.com/GenericMappingTools/pygmt/pull/4780)) +* Figure.image: Add parameter 'fgcolor'/'bgcolor'/'transparent_color' and deprecate 'bitcolor' [Will be removed in 0.24.0] ([#4872](https://github.com/GenericMappingTools/pygmt/pull/4872)) +* pygmt.blockmean/blockmedian/blockmode: Add parameter 'center' (-C) ([#4780](https://github.com/GenericMappingTools/pygmt/pull/4780)) ### Deprecations -* Figure.grdview: Remove the deprecated parameters '*pen'/'drapegrid' ([#4830](https://github.com/GenericMappingTools/pygmt/pull/4830)) +* Figure.grdview: Remove the deprecated parameters '*pen'/'drapegrid' ([#4830](https://github.com/GenericMappingTools/pygmt/pull/4830)) * Figure.grdcontour: Remove the deprecated 'interval' parameter [Deprecated since v0.12.0] ([#4764](https://github.com/GenericMappingTools/pygmt/pull/4764)) * Figure.histogram: Add parameter 'out_range' to handle extreme values and deprecate parameter 'extreme' ([#4882](https://github.com/GenericMappingTools/pygmt/pull/4882)) -* Figure.histogram: Add parameters to annote bars and deprecate parameter 'annotate' ([#4895](https://github.com/GenericMappingTools/pygmt/pull/4895)) -* Figure.histogram: Remove the deprecated parameter barwidth [Deprecated since 0.18.0] ([#4827](https://github.com/GenericMappingTools/pygmt/pull/4827)) -* Figure.image: Add parameter fgcolor/bgcolor/transparent_color and deprecate bitcolor [Will be removed in 0.24.0] ([#4872](https://github.com/GenericMappingTools/pygmt/pull/4872)) -* Figure.inset: Remove deprecated parameter margin [Deprecated since 0.18.0] ([#4826](https://github.com/GenericMappingTools/pygmt/pull/4826)) +* Figure.histogram: Add parameters to annotate bars and deprecate parameter 'annotate' ([#4895](https://github.com/GenericMappingTools/pygmt/pull/4895)) +* Figure.histogram: Remove the deprecated parameter 'barwidth' [Deprecated since 0.18.0] ([#4827](https://github.com/GenericMappingTools/pygmt/pull/4827)) +* Figure.image: Add parameter 'fgcolor'/'bgcolor'/'transparent_color' and deprecate 'bitcolor' [Will be removed in 0.24.0] ([#4872](https://github.com/GenericMappingTools/pygmt/pull/4872)) +* Figure.inset: Remove deprecated parameter 'margin' [Deprecated since 0.18.0] ([#4826](https://github.com/GenericMappingTools/pygmt/pull/4826)) * Figure.meca: Remove the deprecated parameters 'label'/'*fill' ([#4829](https://github.com/GenericMappingTools/pygmt/pull/4829)) * Figure.velo: Remove deprecated parameter 'uncertaintyfill' [Deprecated since 0.18.0] ([#4835](https://github.com/GenericMappingTools/pygmt/pull/4835)) * Figure.wiggle: Remove the deprecated parameters 'fillpositive'/'fillnegative' [Deprecated since 0.18.0] ([#4831](https://github.com/GenericMappingTools/pygmt/pull/4831)) -* Session.virtualfile_in: Remove the deprecated parameter 'required_z'/'required_data'/'extra_arrays' [Deprecated since 0.16.0] ([#4828](https://github.com/GenericMappingTools/pygmt/pull/4828)) -* pygmt.grdfill: Remove the deprecated '*fill' parameters [Deprecated since 0.18.0] ([#4836](https://github.com/GenericMappingTools/pygmt/pull/4836)) +* Session.virtualfile_in: Remove the deprecated parameters 'required_z'/'required_data'/'extra_arrays' [Deprecated since 0.16.0] ([#4828](https://github.com/GenericMappingTools/pygmt/pull/4828)) +* pygmt.grdfill: Remove the deprecated parameters '*fill' [Deprecated since 0.18.0] ([#4836](https://github.com/GenericMappingTools/pygmt/pull/4836)) * pygmt.grdlandmask: Remove the deprecated parameters 'maskvalue'/'bordervalues' [Deprecated since 0.18.0] ([#4833](https://github.com/GenericMappingTools/pygmt/pull/4833)) * pygmt.load_dataarray: Remove the deprecated function [Deprecated since v0.16.0] ([#4837](https://github.com/GenericMappingTools/pygmt/pull/4837)) -* pygmt.select: Remove the deprecated parameters mask/gridmask [Deprecated since 0.18.0] ([#4825](https://github.com/GenericMappingTools/pygmt/pull/4825)) +* pygmt.select: Remove the deprecated parameters 'mask'/'gridmask' [Deprecated since 0.18.0] ([#4825](https://github.com/GenericMappingTools/pygmt/pull/4825)) * pygmt.surface: Remove the deprecated parameter 'maxradius' [Deprecated since 0.18.0] ([#4832](https://github.com/GenericMappingTools/pygmt/pull/4832)) * pygmt.x2sys_cross: Remove the deprecated parameter 'trackvalues' [Deprecated since 0.18.0] ([#4834](https://github.com/GenericMappingTools/pygmt/pull/4834)) @@ -57,7 +57,8 @@ * Add a separate documentation for supported plot and distance units ([#4359](https://github.com/GenericMappingTools/pygmt/pull/4359)) * Add blockmedian and surface gallery example ([#4771](https://github.com/GenericMappingTools/pygmt/pull/4771)) -* DOC: Demonstrate straight_line in Plotting Lines tutorial ([#4971](https://github.com/GenericMappingTools/pygmt/pull/4971)) +* DOC: Demonstrate parameter 'straight_line' in tutorial "Plotting lines" ([#4971](https://github.com/GenericMappingTools/pygmt/pull/4971)) +* DOC: Improve tutorial "Cartesian histograms" ([#4965](https://github.com/GenericMappingTools/pygmt/pull/4965)) * DOC: Document the supported array dtypes ([#3582](https://github.com/GenericMappingTools/pygmt/pull/3582)) * Figuer.ternary: Add an inline example ([#4931](https://github.com/GenericMappingTools/pygmt/pull/4931)) * Figure.contour: Add an inline example ([#4934](https://github.com/GenericMappingTools/pygmt/pull/4934)) From 0d96a010ebf34a9f04c19d3ffbd445a3faa3193d Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Tue, 17 Nov 2026 10:21:17 +0800 Subject: [PATCH 09/12] Fix changelog entry about GMT 6.7.0 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com> --- doc/changes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/changes.md b/doc/changes.md index 1f8f271b0a6..5b85f2e1620 100644 --- a/doc/changes.md +++ b/doc/changes.md @@ -46,7 +46,7 @@ ### Bug Fixes -* Figure.directional_rose/Figure.magnetic_rose: Fix compatibility with upcoming GMT 6.7.0 ([#4729](https://github.com/GenericMappingTools/pygmt/pull/4729)) +* Figure.directional_rose/Figure.magnetic_rose: Fix compatibility with GMT 6.7.0 ([#4729](https://github.com/GenericMappingTools/pygmt/pull/4729)) * Figure.grdview: Fix the default z-plane with GMT 6.7.0 ([#4804](https://github.com/GenericMappingTools/pygmt/pull/4804)) * Figure.solar: Fix the bug that terminator datetime doesn't support fractional timezone offsets ([#4916](https://github.com/GenericMappingTools/pygmt/pull/4916)) * Figure.tilemap/pygmt.datasets.tile_map: Set User-Agent to avoid blocked access to OSM tile server ([#4816](https://github.com/GenericMappingTools/pygmt/pull/4816)) From b8e2d86d0953758ac6a28afb4f86d278fdb36c66 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Tue, 17 Nov 2026 10:23:22 +0800 Subject: [PATCH 10/12] Move the changelog entry for the histogram tutorial MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com> --- doc/changes.md | 1 - 1 file changed, 1 deletion(-) diff --git a/doc/changes.md b/doc/changes.md index 5b85f2e1620..3e539c8ce8b 100644 --- a/doc/changes.md +++ b/doc/changes.md @@ -72,7 +72,6 @@ * Figure.tilemap: Add two inline examples ([#4928](https://github.com/GenericMappingTools/pygmt/pull/4928)) * Figure.velo: Add inline example ([#4944](https://github.com/GenericMappingTools/pygmt/pull/4944)) * Figure.wiggle: Add an inline example ([#4936](https://github.com/GenericMappingTools/pygmt/pull/4936)) -* Improve the Cartesian histogram tutorial ([#4965](https://github.com/GenericMappingTools/pygmt/pull/4965)) * Stop recommending mamba in installation guides and error messages ([#4766](https://github.com/GenericMappingTools/pygmt/pull/4766)) ### Maintenance From 806d4ed6ba15379318161d21000dab2aab257bc7 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Wed, 18 Nov 2026 16:28:13 +0800 Subject: [PATCH 11/12] Add highlights MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com> --- doc/changes.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/doc/changes.md b/doc/changes.md index 3e539c8ce8b..de63eb6102c 100644 --- a/doc/changes.md +++ b/doc/changes.md @@ -6,7 +6,11 @@ ### Highlights -* +* 🎉 Twentieth minor release of PyGMT 🎉 +* Redesign the PyGMT website +* Refractor `Figure.histogram` for a more Pythonic interface +* Add several new inline examples and two updated tutorials +* Add support for Python 3.15 ### Enhancements From 67c6acfa427c8b3769dd22b77cdd26c73a6e0a74 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Wed, 18 Nov 2026 16:28:35 +0800 Subject: [PATCH 12/12] Remove the "DOC: " prefix from changelog entries --- doc/changes.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/changes.md b/doc/changes.md index de63eb6102c..c113a61ac6e 100644 --- a/doc/changes.md +++ b/doc/changes.md @@ -61,9 +61,9 @@ * Add a separate documentation for supported plot and distance units ([#4359](https://github.com/GenericMappingTools/pygmt/pull/4359)) * Add blockmedian and surface gallery example ([#4771](https://github.com/GenericMappingTools/pygmt/pull/4771)) -* DOC: Demonstrate parameter 'straight_line' in tutorial "Plotting lines" ([#4971](https://github.com/GenericMappingTools/pygmt/pull/4971)) -* DOC: Improve tutorial "Cartesian histograms" ([#4965](https://github.com/GenericMappingTools/pygmt/pull/4965)) -* DOC: Document the supported array dtypes ([#3582](https://github.com/GenericMappingTools/pygmt/pull/3582)) +* Demonstrate parameter 'straight_line' in tutorial "Plotting lines" ([#4971](https://github.com/GenericMappingTools/pygmt/pull/4971)) +* Improve tutorial "Cartesian histograms" ([#4965](https://github.com/GenericMappingTools/pygmt/pull/4965)) +* Document the supported array dtypes ([#3582](https://github.com/GenericMappingTools/pygmt/pull/3582)) * Figuer.ternary: Add an inline example ([#4931](https://github.com/GenericMappingTools/pygmt/pull/4931)) * Figure.contour: Add an inline example ([#4934](https://github.com/GenericMappingTools/pygmt/pull/4934)) * Figure.legend: Add an inline example ([#4930](https://github.com/GenericMappingTools/pygmt/pull/4930))