Skip to content
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.

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

Changelog entry for v0.14.0 #3730

Merged
merged 31 commits into from
Dec 31, 2024
Merged
Show file tree
Hide file tree
Changes from 17 commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
d8659c1
Add v0.14.0 entry in doc/_static/version_switch.js for documentation …
seisman Dec 28, 2024
5c9272f
Add the version to the compatibility table doc/minversions.md
seisman Dec 28, 2024
d05426f
Update citation information CITATION.cff and BibTeX in README
seisman Dec 28, 2024
9fd98fc
Copy the draft release note from the release page
seisman Dec 28, 2024
f15e9fc
Update the release date and the DOI badge in doc/changes
seisman Dec 28, 2024
685032d
Update the author order in doc/changes.md
seisman Dec 28, 2024
fb2b922
Apply suggestions from code review
seisman Dec 29, 2024
97e519a
Merge branch 'main' into changelog/v0.14.0
seisman Dec 29, 2024
92f9e75
Apply suggestions from code review
seisman Dec 29, 2024
73a37e5
Sort entries in the 'New Features' category
seisman Dec 29, 2024
f4ad6a8
Sort entries in the 'Enhancements' category
seisman Dec 29, 2024
da7e08c
Sort entries in the 'Deprecations' category
seisman Dec 29, 2024
9e44750
Sort entries in the 'Bug Fixes' category
seisman Dec 29, 2024
31788f3
Sort entries in the 'Documentation' category
seisman Dec 29, 2024
39561f7
Sort entries in the 'Maintenance' category
seisman Dec 29, 2024
5e3cc60
Remove double quotes from function names
seisman Dec 30, 2024
71bc440
Add two highlights
seisman Dec 30, 2024
895bbfe
Fix Jing-Hui Tong's name
seisman Dec 30, 2024
b036466
Clean up some changelog entries
seisman Dec 30, 2024
e41a063
Add more highlights
seisman Dec 30, 2024
173e2ee
Remove unimportant CI entries
seisman Dec 30, 2024
9eda152
Add the entry for load_earth_deflection
seisman Dec 30, 2024
6fd6a46
Fix the entry for pre-conference workshop
seisman Dec 30, 2024
6eb095b
Merge branch 'main' into changelog/v0.14.0
seisman Dec 30, 2024
e69fb3f
Move the 'Python 3.13 support' entry back to maintainence
seisman Dec 30, 2024
894fe93
Move Jing-Hui up for the AGU24 contribution
seisman Dec 30, 2024
ad2ada9
Consistently use double quotes
seisman Dec 30, 2024
ee710e8
Sort entries for load_xxx function alphabetically
seisman Dec 31, 2024
2625479
Add pyarrow to highlight
seisman Dec 31, 2024
624a90f
Add an entry for PR #3711
seisman Dec 31, 2024
282c5a9
Merge branch 'main' into changelog/v0.14.0
seisman Dec 31, 2024
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
6 changes: 3 additions & 3 deletions CITATION.cff
Copy link
Member

Choose a reason for hiding this comment

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

Output of git shortlog -sne at commit 1256d15, trimmed to those with >=3 commits (after merging some names).

  1051  Dongdong Tian <[email protected]>
   276  Yvonne Fröhlich <[email protected]>
   264  dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
   261  Wei Ji <[email protected]>
   256  Leonardo Uieda <[email protected]>
   192  Will Schlitzer <[email protected]>
   145  Michael Grund <[email protected]>
   110  Max Jones <[email protected]>
    33  Yao Jiayuan <[email protected]>
    15  Liam Toney <[email protected]>
     7  yohaimagen <[email protected]>
     5  Tong <[email protected]>
     3  Andre L. Belem <[email protected]>
     3  kmaterna <[email protected]>

Do we want to re-arrange any positions?

Copy link
Member Author

@seisman seisman Dec 30, 2024

Choose a reason for hiding this comment

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

The GitHub contributors page (https://github.com/GenericMappingTools/pygmt/graphs/contributors) shows totally different numbers of commits, likely because GitHub also takes co-authorship into consideration. I feel these numbers (including the numbers of additions and deletions) make more sense.

Currently, the author order is,

Tian, Uieda, Leong, Fröhlich, Schlitzer, Grund, Jones, Toney, Yao, Magen, Tong, Materna, Belem, Anant, Ziebarth, Quinn, Wessel.

Considering that Leo is no longer active, maybe

Tian, Leong, Fröhlich, Schlitzer, Grund, Uieda, ...

BTW, I just found that Jing-Hui Tong's given/family names are incorrectly swapped and have fixed it in 895bbfe.

Copy link
Member

Choose a reason for hiding this comment

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

I was thinking of moving Leo's name to the end too, when we decide to remove Paul's name (#3425 (comment)). We'll probably need to update the authorship policy before doing this, so let's keep those positions intact for now.

Thanks for spotting Jing-Hui's incorrect name order... Btw, I think we could move her up one spot given her contributions during the AGU24 workshop?

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 think we could move her up one spot given her contributions during the AGU24 workshop?

Sounds reasonable. Done in 894fe93.

Copy link
Member

@yvonnefroehlich yvonnefroehlich Dec 30, 2024

Choose a reason for hiding this comment

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

Yeah, moving Jing-Hui up in the author order is definitely fair.

Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,9 @@ authors:
family-names: Wessel
affiliation: University of Hawaiʻi at Mānoa, USA
orcid: https://orcid.org/0000-0001-5708-7336
date-released: 2024-09-05
doi: 10.5281/zenodo.13679420
date-released: 2024-12-31
doi: 10.5281/zenodo.14535921
license: BSD-3-Clause
repository-code: https://github.com/GenericMappingTools/pygmt
type: software
version: 0.13.0
version: 0.14.0
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ research using the following BibTeX:

```
@software{
pygmt_2024_13679420,
pygmt_2024_14535921,
author = {Tian, Dongdong and
Uieda, Leonardo and
Leong, Wei Ji and
Expand All @@ -152,12 +152,12 @@ research using the following BibTeX:
Quinn, Jamie and
Wessel, Paul},
title = {{PyGMT: A Python interface for the Generic Mapping Tools}},
month = sep,
month = dec,
year = 2024,
publisher = {Zenodo},
version = {0.13.0},
doi = {10.5281/zenodo.13679420},
url = {https://doi.org/10.5281/zenodo.13679420}
version = {0.14.0},
doi = {10.5281/zenodo.14535921},
url = {https://doi.org/10.5281/zenodo.14535921}
}
```

Expand Down
1 change: 1 addition & 0 deletions doc/_static/version_switch.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
var all_versions = {
'latest': 'latest',
'dev': 'dev',
'v0.14.0': 'v0.14.0',
'v0.13.0': 'v0.13.0',
'v0.12.0': 'v0.12.0',
'v0.11.0': 'v0.11.0',
Expand Down
108 changes: 108 additions & 0 deletions doc/changes.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,113 @@
# Changelog

## Release v0.14.0 (2024/12/31)

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

### Highlights

* 🎉 Fourteenth minor release of PyGMT 🎉
* Bump minimum supported version to GMT>=6.4.0 ([#3450](https://github.com/GenericMappingTools/pygmt/pull/3450))
seisman marked this conversation as resolved.
Show resolved Hide resolved

### New Features

* Add Figure.hlines for plotting horizontal lines ([#923](https://github.com/GenericMappingTools/pygmt/pull/923))
* Add Figure.vlines for plotting vertical lines ([#3726](https://github.com/GenericMappingTools/pygmt/pull/3726))
* Add load_blue_marble to load Blue Marble dataset ([#2235](https://github.com/GenericMappingTools/pygmt/pull/2235))
* Add load_black_marble to load Black Marble dataset ([#3469](https://github.com/GenericMappingTools/pygmt/pull/3469))
seisman marked this conversation as resolved.
Show resolved Hide resolved
* Add load_earth_mean_sea_surface to load "CNES Earth Mean Sea Surface" dataset ([#3717](https://github.com/GenericMappingTools/pygmt/pull/3717))
* Add load_earth_mean_dynamic_topography to load "CNES Earth Mean Dynamic Topography" dataset ([#3718](https://github.com/GenericMappingTools/pygmt/pull/3718))
* Add load_earth_dist to load "GSHHG Earth distance to shoreline" dataset ([#3706](https://github.com/GenericMappingTools/pygmt/pull/3706))
seisman marked this conversation as resolved.
Show resolved Hide resolved
* Add "uncertainty" parameter to "load_earth_free_air_anomaly" to load the "free-air anomaly uncertainty" dataset ([#3727](https://github.com/GenericMappingTools/pygmt/pull/3727))
seisman marked this conversation as resolved.
Show resolved Hide resolved


### Enhancements

* Figure.show: Raise ImportError instead of GMTError if IPython is not installed but required ([#3580](https://github.com/GenericMappingTools/pygmt/pull/3580))
seisman marked this conversation as resolved.
Show resolved Hide resolved
* Figure.plot: Add the "symbol" parameter to support plotting data points with varying symbols ([#1117](https://github.com/GenericMappingTools/pygmt/pull/1117))
* Figure.plot3d: Add the "symbol" parameter to support plotting data points with varying symbols ([#3559](https://github.com/GenericMappingTools/pygmt/pull/3559))
* Figure.legend: Support passing a StringIO object as the legend specification ([#3438](https://github.com/GenericMappingTools/pygmt/pull/3438))
* load_tile_map: Add the new parameter 'crs' to set the CRS of the returned dataarray ([#3554](https://github.com/GenericMappingTools/pygmt/pull/3554))
seisman marked this conversation as resolved.
Show resolved Hide resolved
* pyarrow: Support pyarrow arrays with string/large_string/string_view types ([#3619](https://github.com/GenericMappingTools/pygmt/pull/3619))
seisman marked this conversation as resolved.
Show resolved Hide resolved
* Support 1-D/2-D numpy arrays with longlong and ulonglong dtype ([#3566](https://github.com/GenericMappingTools/pygmt/pull/3566))
* GMT_IMAGE: Implement the GMT_IMAGE.to_dataarray method for 3-band images ([#3128](https://github.com/GenericMappingTools/pygmt/pull/3128))
seisman marked this conversation as resolved.
Show resolved Hide resolved
* Ensure non-ASCII characters are typeset correctly even if PS_CHAR_ENCODING is not 'ISOLatin1+' ([#3611](https://github.com/GenericMappingTools/pygmt/pull/3611))
seisman marked this conversation as resolved.
Show resolved Hide resolved
* Add the private _to_numpy function to convert anything to a numpy array ([#3581](https://github.com/GenericMappingTools/pygmt/pull/3581))
seisman marked this conversation as resolved.
Show resolved Hide resolved
* Add enums GridRegistration and GridType for grid registration and type ([#3693](https://github.com/GenericMappingTools/pygmt/pull/3693))
* Add PyArrow as an optional dependency ([#3592](https://github.com/GenericMappingTools/pygmt/pull/3592))
yvonnefroehlich marked this conversation as resolved.
Show resolved Hide resolved

### Deprecations

* SPEC 0: Bump minimum supported versions to Python 3.11, NumPy 1.25, pandas>=2.0 and xarray>=2023.04 ([#3460](https://github.com/GenericMappingTools/pygmt/pull/3460), [#3606](https://github.com/GenericMappingTools/pygmt/pull/3606), [#3697](https://github.com/GenericMappingTools/pygmt/pull/3697))
* clib.Session.virtualfile_from_vectors: Now takes a sequence of vectors as its single argument (Passing multiple arguments will be unsupported in v0.16.0) ([#3522](https://github.com/GenericMappingTools/pygmt/pull/3522))
* Remove the deprecated build_arg_string function (deprecated since v0.12.0) ([#3427](https://github.com/GenericMappingTools/pygmt/pull/3427))
* Figure.grdcontour: Remove the deprecated syntax for the 'annotation' parameter ([#3428](https://github.com/GenericMappingTools/pygmt/pull/3428))
seisman marked this conversation as resolved.
Show resolved Hide resolved

### Bug Fixes

* launch_external_viewer: Use full path when opening the file in a web browser ([#3647](https://github.com/GenericMappingTools/pygmt/pull/3647))
* pyarrow: Map date32[day]/date64[ms] dtypes in pandas objects to np.datetime64 with correct date/time units ([#3617](https://github.com/GenericMappingTools/pygmt/pull/3617))
seisman marked this conversation as resolved.
Show resolved Hide resolved
* clib.session: Add the GMT_SESSION_NOGDALCLOSE flag to keep GDAL open ([#3672](https://github.com/GenericMappingTools/pygmt/pull/3672))
* Set the 'Conventions' attribute to 'CF-1.7' for netCDF grids only ([#3463](https://github.com/GenericMappingTools/pygmt/pull/3463))
seisman marked this conversation as resolved.
Show resolved Hide resolved
* Fix the conversion error for pandas.Series with missing values in pandas<=2.1 ([#3505](https://github.com/GenericMappingTools/pygmt/pull/3505), [#3596](https://github.com/GenericMappingTools/pygmt/pull/3596))
* GeoPandas: Explicitly convert columns with overflow integers to avoid OverflowError with fiona 1.10 ([#3455](https://github.com/GenericMappingTools/pygmt/pull/3455))
* Figure.plot/Figure.plot3d: Improve the check of the "style" parameter for "v" or "V" ([#3603](https://github.com/GenericMappingTools/pygmt/pull/3603))
* Correctly reserve the grid data dtype by converting ctypes array to numpy array with np.ctypeslib.as_array ([#3446](https://github.com/GenericMappingTools/pygmt/pull/3446))
* **Breaking**: Figure.text: Fix typesetting of integers when mixed with floating-point values ([#3493](https://github.com/GenericMappingTools/pygmt/pull/3493))

### Documentation

* Add basic tutorial "Plotting polygons" ([#3593](https://github.com/GenericMappingTools/pygmt/pull/3593))
* Add the PyGMT ecosystem page ([#3475](https://github.com/GenericMappingTools/pygmt/pull/3475))
* Document the support policy for optional packages ([#3616](https://github.com/GenericMappingTools/pygmt/pull/3616))
* Document the environment variables that can affect the behavior of PyGMT ([#3432](https://github.com/GenericMappingTools/pygmt/pull/3432))
* Document the built-in patterns in the Technical Reference section ([#3466](https://github.com/GenericMappingTools/pygmt/pull/3466))
* Document Continuous Benchmarking in Maintainers Guides ([#3631](https://github.com/GenericMappingTools/pygmt/pull/3631))
* Add instructions for installing optional dependencies ([#3506](https://github.com/GenericMappingTools/pygmt/pull/3506))
* Update "PyData Ecosystem" to "Scientific Python Ecosystem" ([#3447](https://github.com/GenericMappingTools/pygmt/pull/3447))
* Figure.savefig: Clarify that 'transparent' also works for the PNG file associated with the KML format ([#3579](https://github.com/GenericMappingTools/pygmt/pull/3579))
seisman marked this conversation as resolved.
Show resolved Hide resolved
* Add the PyGMT talk at AGU24 to the "Overview" section ([#3685](https://github.com/GenericMappingTools/pygmt/pull/3685))
* Add the GMT/PyGMT preworkshop at AGU24 to the "External resources" section ([#3689](https://github.com/GenericMappingTools/pygmt/pull/3689))
seisman marked this conversation as resolved.
Show resolved Hide resolved
* Add TODO comments in the maintainers guides and update the release checklist ([#3724](https://github.com/GenericMappingTools/pygmt/pull/3724))

### Maintenance

seisman marked this conversation as resolved.
Show resolved Hide resolved
* **Breaking**: data_kind: data is None and required now returns the 'empty' kind ([#3482](https://github.com/GenericMappingTools/pygmt/pull/3482))
* **Breaking**: data_kind: Now 'matrix' represents a 2-D numpy array and unrecognized data types fall back to 'vectors' ([#3351](https://github.com/GenericMappingTools/pygmt/pull/3351))
seisman marked this conversation as resolved.
Show resolved Hide resolved
* Add the Session.virtualfile_from_stringio method to allow StringIO input for certain functions/methods ([#3326](https://github.com/GenericMappingTools/pygmt/pull/3326))
* Add 'geodatasets' as a dependency for docs and update the choropleth example ([#3719](https://github.com/GenericMappingTools/pygmt/pull/3719))
seisman marked this conversation as resolved.
Show resolved Hide resolved
* pyarrow: Check compatibility of pyarrow.array with string type ([#2933](https://github.com/GenericMappingTools/pygmt/pull/2933))
seisman marked this conversation as resolved.
Show resolved Hide resolved
* doc: Rename sphinx-gallery's README.txt to GALLERY_HEADER.rst and require Sphinx-Gallery>=0.17.0 ([#3348](https://github.com/GenericMappingTools/pygmt/pull/3348))
seisman marked this conversation as resolved.
Show resolved Hide resolved
* clib.conversion: Remove the as_c_contiguous function and use np.ascontiguousarray instead ([#3492](https://github.com/GenericMappingTools/pygmt/pull/3492))
* Use TODO comments to track deprecations and workarounds ([#3722](https://github.com/GenericMappingTools/pygmt/pull/3722))
* Pin numpy<2 in ci_tests_legacy.yaml ([#3641](https://github.com/GenericMappingTools/pygmt/pull/3641))
seisman marked this conversation as resolved.
Show resolved Hide resolved
* Move Figure.psconvert into a separate file ([#3553](https://github.com/GenericMappingTools/pygmt/pull/3553))
* Improve the data type checking for 2-D arrays passed to the GMT C API ([#3563](https://github.com/GenericMappingTools/pygmt/pull/3563))
* Enable ruff's TD (flake8-todos), COM (flake8-commas), TRY (tryceratops), and EM (flake8-errmsg) rules ([#3723](https://github.com/GenericMappingTools/pygmt/pull/3723), [#3531](https://github.com/GenericMappingTools/pygmt/pull/3531), [#3665](https://github.com/GenericMappingTools/pygmt/pull/3665), [#3661](https://github.com/GenericMappingTools/pygmt/pull/3661))
* CI: Use windows-2025 in the GMT Dev Tests workflow ([#3701](https://github.com/GenericMappingTools/pygmt/pull/3701))
* CI: Test NumPy 2.2 in the GMT Tests workflow ([#3677](https://github.com/GenericMappingTools/pygmt/pull/3677))
* CI: Run the 'GMT Tests' workflow on Python 3.10/3.12 with optional packages and Python 3.11 without optional packages ([#3618](https://github.com/GenericMappingTools/pygmt/pull/3618))
* CI: Remove the pytest-xdist plugin from the "Tests" and "Dev Tests" workflows ([#3627](https://github.com/GenericMappingTools/pygmt/pull/3627))
* CI: Pin to sphinx>=6.2 for docs build on Python 3.13 ([#3667](https://github.com/GenericMappingTools/pygmt/pull/3667))
seisman marked this conversation as resolved.
Show resolved Hide resolved
* CI: Install pyarrow-core instead of pyarrow from conda-forge ([#3698](https://github.com/GenericMappingTools/pygmt/pull/3698))
* CI: Ensure no hyphens in Python file and directory names in the "Style Checks" workflow ([#3703](https://github.com/GenericMappingTools/pygmt/pull/3703))
* CI: Add a separate CI job on Ubuntu to test geopandas v0.x ([#3420](https://github.com/GenericMappingTools/pygmt/pull/3420))
seisman marked this conversation as resolved.
Show resolved Hide resolved
* Bump to ruff>=0.8.0 and rename rule TCH to TC ([#3662](https://github.com/GenericMappingTools/pygmt/pull/3662))
* Bump to Ghostscript 10.04.0 ([#3443](https://github.com/GenericMappingTools/pygmt/pull/3443))
* Add support for Python 3.13 ([#3490](https://github.com/GenericMappingTools/pygmt/pull/3490))
seisman marked this conversation as resolved.
Show resolved Hide resolved
* Add enums GridFormat for GMT grid format ID ([#3449](https://github.com/GenericMappingTools/pygmt/pull/3449))

**Full Changelog**: <https://github.com/GenericMappingTools/pygmt/compare/v0.13.0...v0.14.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)
* [Will Schlitzer](https://github.com/willschlitzer)
* [Jiayuan Yao](https://github.com/core-man)

## Release v0.13.0 (2024/09/05)

[![Digital Object Identifier for PyGMT v0.13.0](https://zenodo.org/badge/DOI/10.5281/zenodo.13679420.svg)](https://doi.org/10.5281/zenodo.13679420)
Expand Down
1 change: 1 addition & 0 deletions doc/minversions.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ compatibility reasons.
| PyGMT Version | GMT | Python | NumPy | pandas | Xarray |
|---|---|---|---|---|---|
| [Dev][]* [<doc:dev>] | {{ requires.gmt }} | {{ requires.python }} | {{ requires.numpy }} | {{ requires.pandas }} | {{ requires.xarray }} |
| <tag:v0.14.0> [<doc:v0.14.0>] | >=6.4.0 | >=3.11 | >=1.25 | >=2.0 | >=2023.04 |
| <tag:v0.13.0> [<doc:v0.13.0>] | >=6.3.0 | >=3.10 | >=1.24 | >=1.5 | >=2022.09 |
| <tag:v0.12.0> [<doc:v0.12.0>] | >=6.3.0 | >=3.10 | >=1.23 | >=1.5 | >=2022.06 |
| <tag:v0.11.0> [<doc:v0.11.0>] | >=6.3.0 | >=3.9 | >=1.23 | | |
Expand Down
Loading