Skip to content

Changelog entry for v0.17.0 #4121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 12 commits into
base: main
Choose a base branch
from
+82 −14
Draft

Changelog entry for v0.17.0 #4121

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
a8d1583
Add entry in doc/_static/version_switch.js for documentation switcher
seisman Sep 25, 2025
8f5dd4e
Add the version to the compatibility table doc/minversions.md
seisman Sep 25, 2025
51de6d7
Update citation information CITATION.cff and BibTeX in README
seisman Sep 25, 2025
b8d6ee3
Move Leo to second last and update affiliation
seisman Sep 25, 2025
2d2eb7e
Copy the draft release note from the release page
seisman Sep 25, 2025
0a4129c
Update release date, doi and contributors in the changelog
seisman Sep 25, 2025
3ce82da
Add PR #4020 [skip ci]
seisman Sep 26, 2025
959aa13
Merge some entries [skip ci]
seisman Sep 26, 2025
985ba90
Polish some changelog entries [skip ci]
seisman Sep 26, 2025
c7d900b
Reorder entries
seisman Sep 26, 2025
a15872f
Remove one duplicate entry
seisman Sep 26, 2025
366b423
Merge branch 'main' into changelog/v0.17.0
seisman Sep 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion AUTHORS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The following people have contributed code and/or documentation to the project
| [Jiayuan Yao](https://github.com/core-man) | [0000-0001-7036-4238](https://orcid.org/0000-0001-7036-4238) | Nanyang Technological University, Singapore |
| [Jing-Hui Tong](https://github.com/jhtong33) | [0009-0002-7195-3071](https://orcid.org/0009-0002-7195-3071) | National Taiwan Normal University, Taiwan |
| [Kathryn Materna](https://github.com/kmaterna) | [0000-0002-6687-980X](https://orcid.org/0000-0002-6687-980X) | US Geological Survey, USA |
| [Leonardo Uieda](https://www.leouieda.com/) | [0000-0001-6123-9515](https://orcid.org/0000-0001-6123-9515) | University of Liverpool, United Kingdom |
| [Leonardo Uieda](https://www.leouieda.com/) | [0000-0001-6123-9515](https://orcid.org/0000-0001-6123-9515) | Universidade de São Paulo, Brazil |
| [Liam Toney](https://liam.earth/) | [0000-0003-0167-9433](https://orcid.org/0000-0003-0167-9433) | University of Alaska Fairbanks, USA |
| [Malte Ziebarth](https://github.com/mjziebarth) | [0000-0002-5190-4478](https://orcid.org/0000-0002-5190-4478) | GFZ German Research Centre for Geosciences, Germany |
| [Max Jones](https://github.com/maxrjones) | [0000-0003-0180-8928](https://orcid.org/0000-0003-0180-8928) | University of Hawaiʻi at Mānoa, USA |
Expand Down
14 changes: 7 additions & 7 deletions CITATION.cff
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,6 @@ authors:
family-names: Tian
affiliation: China University of Geosciences, China
orcid: https://orcid.org/0000-0001-7967-1197
- given-names: Leonardo
family-names: Uieda
affiliation: University of Liverpool, United Kingdom
orcid: https://orcid.org/0000-0001-6123-9515
- given-names: Wei Ji
family-names: Leong
affiliation: Development Seed, USA
Expand Down Expand Up @@ -72,13 +68,17 @@ authors:
family-names: Quinn
affiliation: University College London, United Kingdom
orcid: https://orcid.org/0000-0002-0268-7032
- given-names: Leonardo
family-names: Uieda
affiliation: Universidade de São Paulo, Brazil
orcid: https://orcid.org/0000-0001-6123-9515
- given-names: Paul
family-names: Wessel
affiliation: University of Hawaiʻi at Mānoa, USA
orcid: https://orcid.org/0000-0001-5708-7336
date-released: 2025-06-18
doi: 10.5281/zenodo.15628725
date-released: 2025-09-30
doi: 10.5281/zenodo.17156962
license: BSD-3-Clause
repository-code: https://github.com/GenericMappingTools/pygmt
type: software
version: 0.16.0
version: 0.17.0
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,9 +137,8 @@ Feel free to cite our work in your research using the following BibTeX:

```
@software{
pygmt_2025_15628725,
pygmt_2025_17156962,
author = {Tian, Dongdong and
Uieda, Leonardo and
Leong, Wei Ji and
Fröhlich, Yvonne and
Grund, Michael and
Expand All @@ -155,14 +154,15 @@ Feel free to cite our work in your research using the following BibTeX:
Anant, Abhishek and
Ziebarth, Malte and
Quinn, Jamie and
Uieda, Leonardo and
Wessel, Paul},
title = {{PyGMT: A Python interface for the Generic Mapping Tools}},
month = jun,
month = sep,
year = 2025,
publisher = {Zenodo},
version = {0.16.0},
doi = {10.5281/zenodo.15628725},
url = {https://doi.org/10.5281/zenodo.15628725}
version = {0.17.0},
doi = {10.5281/zenodo.17156962},
url = {https://doi.org/10.5281/zenodo.17156962}
}
```

Expand Down
1 change: 1 addition & 0 deletions doc/_static/version_switch.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
var all_versions = {
'latest': 'latest',
'dev': 'dev',
'v0.17.0': 'v0.17.0',
'v0.16.0': 'v0.16.0',
'v0.15.0': 'v0.15.0',
'v0.14.2': 'v0.14.2',
Expand Down
67 changes: 67 additions & 0 deletions doc/changes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,72 @@
# Changelog

## Release v0.17.0 (2025/09/30)

[![Digital Object Identifier for PyGMT v0.17.0](https://zenodo.org/badge/DOI/10.5281/zenodo.17156962.svg)](https://doi.org/10.5281/zenodo.17156962)

### Highlights

*
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I propose these three highlights. What do you think?

Suggested change
*
* 🎉 Seventeenth minor release of PyGMT 🎉
* Implement the new alias system towards to a Pythonic interface ([#3986](https://github.com/GenericMappingTools/pygmt/pull/3986), [#4000](https://github.com/GenericMappingTools/pygmt/pull/4000), [#3993](https://github.com/GenericMappingTools/pygmt/pull/3993))
* GMTDataArrayAccessor: Support applying grid operations on the current xarray.DataArray object ([#3854](https://github.com/GenericMappingTools/pygmt/pull/3854))

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good for me.


### New Features

* GMTDataArrayAccessor: Support applying grid operations on the current xarray.DataArray object ([#3854](https://github.com/GenericMappingTools/pygmt/pull/3854))
* Add the Box class for specifying the box of GMT embellishments ([#3995](https://github.com/GenericMappingTools/pygmt/pull/3995))
* Add the Pattern class for specifying bit and hachure patterns to fill symbols and polygons ([#4020](https://github.com/GenericMappingTools/pygmt/pull/4020))

### Enhancements

* sequence_join: Correctly join datetime-like values in pd.DataFrame/xr.DataArray objects ([#4097](https://github.com/GenericMappingTools/pygmt/pull/4097))
* pygmt.show_versions: Report GDAL version by calling the GDAL C function ([#4104](https://github.com/GenericMappingTools/pygmt/pull/4104))
* pygmt.binstats: Let the parameter 'statistic' support descriptive arguments ([#3012](https://github.com/GenericMappingTools/pygmt/pull/3012))
* Implement the new alias system towards to a Pythonic interface ([#3986](https://github.com/GenericMappingTools/pygmt/pull/3986), [#4000](https://github.com/GenericMappingTools/pygmt/pull/4000), [#3993](https://github.com/GenericMappingTools/pygmt/pull/3993))
* Migrate the parameter 'verbose' to the new alias system and let it support descriptive arguments ([#4039](https://github.com/GenericMappingTools/pygmt/pull/4039))
* Figure.solar: Support terminator datetime with timezone ([#4112](https://github.com/GenericMappingTools/pygmt/pull/4112))
* Figure.logo: Let the 'style' parameter support descriptive arguments ([#4074](https://github.com/GenericMappingTools/pygmt/pull/4074))
* **BREAKING** Raise GMTValueError exception for invalid values. Previously raise GMTInvalidInput ([#3985](https://github.com/GenericMappingTools/pygmt/pull/3985), [#3998](https://github.com/GenericMappingTools/pygmt/pull/3998))
* **BREAKING** Raise GMTTypeError exception for invalid types. Previously raise GMTInvalidInput ([#3999](https://github.com/GenericMappingTools/pygmt/pull/3999))

### Deprecations

* sequence_join/_to_string/Alias: Deprecate parameter 'separator', use 'sep' instead. [Will be removed in v0.19.0] ([#4033](https://github.com/GenericMappingTools/pygmt/pull/4033))

### Bug Fixes

* x2sys_cross: Fix IndexError to allow empty dataframe outputs ([#4060](https://github.com/GenericMappingTools/pygmt/pull/4060))
* is_nonstr_iter: 0-D array is now recognized as non-iterable ([#4004](https://github.com/GenericMappingTools/pygmt/pull/4004))
* _to_string: Fix the bug when a 2-D sequence is passed ([#4032](https://github.com/GenericMappingTools/pygmt/pull/4032))
* Fix the bug when passing a sequence that contains True to a parameter ([#3982](https://github.com/GenericMappingTools/pygmt/pull/3982))

### Documentation

* Add gallery example to show text formatting ([#3987](https://github.com/GenericMappingTools/pygmt/pull/3987))
* Add gallery example for using EPSG codes ([#3973](https://github.com/GenericMappingTools/pygmt/pull/3973))
* Add Technical Reference page for justification codes ([#4028](https://github.com/GenericMappingTools/pygmt/pull/4028))
* Add Technical Reference page for text formatting ([#3976](https://github.com/GenericMappingTools/pygmt/pull/3976))

### Maintenance

* sequence_join/_to_string/Alias: Deprecate parameter 'separator', use 'sep' instead. [Will be removed in v0.19.0] ([#4033](https://github.com/GenericMappingTools/pygmt/pull/4033))
* **BREAKING** Figure.text: Raise GMTTypeError if text is a sequence when position is given ([#4065](https://github.com/GenericMappingTools/pygmt/pull/4065))
* **BREAKING** Figure.grdimage: Raise NotImplementedError instead of GMTInvalidInput for -A option ([#4062](https://github.com/GenericMappingTools/pygmt/pull/4062))
* Switch from pre-commit to prek ([#4082](https://github.com/GenericMappingTools/pygmt/pull/4082))
* SPEC 0: Bump minimum supported version to pandas 2.2 and Xarray 2023.10 ([#4092](https://github.com/GenericMappingTools/pygmt/pull/4092), [#4091](https://github.com/GenericMappingTools/pygmt/pull/4091))
* Remove the support of non-aliased aliases in use_alias/fmt_docstrings ([#4042](https://github.com/GenericMappingTools/pygmt/pull/4042))
* CI: Bump to macOS 26 in the GMT Dev Tests workflow ([#4084](https://github.com/GenericMappingTools/pygmt/pull/4084))
* CI: Bump to macOS 14 in the GMT Legacy Tests workflow ([#3996](https://github.com/GenericMappingTools/pygmt/pull/3996))
* CI: Access DagsHub repository via an access token ([#4078](https://github.com/GenericMappingTools/pygmt/pull/4078))

**Full Changelog**: <https://github.com/GenericMappingTools/pygmt/compare/v0.16.0...v0.17.0>

### Contributors

* [Dongdong Tian](https://github.com/seisman)
* [Yvonne Fröhlich](https://github.com/yvonnefroehlich)
* [Wei Ji Leong](https://github.com/weiji14)
* [Michael Grund](https://github.com/michaelgrund)

---

## Release v0.16.0 (2025/06/18)

[![Digital Object Identifier for PyGMT v0.16.0](https://zenodo.org/badge/DOI/10.5281/zenodo.15628725.svg)](https://doi.org/10.5281/zenodo.15628725)
Expand Down
1 change: 1 addition & 0 deletions doc/minversions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ compatibility reasons.
| PyGMT Version | Documentation | GMT | Python | NumPy | pandas | Xarray |
|---|---|---|---|---|---|---|
| [Dev][]* | <doc:dev>, [HTML+ZIP](doc:dev/pygmt-docs.zip), [PDF](doc:dev/pygmt-docs.pdf) | {{ requires.gmt }} | {{ requires.python }} | {{ requires.numpy }} | {{ requires.pandas }} | {{ requires.xarray }} |
| <tag:v0.17.0> | <doc:v0.17.0>, <html:v0.17.0>, <pdf:v0.17.0> | >=6.4.0 | >=3.11 | >=1.26 | >=2.2 | >=2023.10 |
| <tag:v0.16.0> | <doc:v0.16.0>, <html:v0.16.0>, <pdf:v0.16.0> | >=6.4.0 | >=3.11 | >=1.26 | >=2.1 | >=2023.07 |
| <tag:v0.15.0> | <doc:v0.15.0>, <html:v0.15.0>, <pdf:v0.15.0> | >=6.4.0 | >=3.11 | >=1.25 | >=2.0 | >=2023.04 |
| <tag:v0.14.2> | <doc:v0.14.2>, <html:v0.14.2> | >=6.4.0 | >=3.11 | >=1.25 | >=2.0 | >=2023.04 |
Expand Down