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.

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

Jump to bottom

Changelog entry for v0.10.0 #2651

Merged
merged 25 commits into from
Sep 2, 2023
Merged

Changelog entry for v0.10.0 #2651

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
be43a3e
Add changelog entry to version switcher
weiji14 Aug 31, 2023
4ff58f1
Update compatibility table
weiji14 Aug 31, 2023
3b5cc79
Update citation
weiji14 Aug 31, 2023
a65f4a7
Add draft changelog
weiji14 Aug 31, 2023
915504c
Add PR #2466 to changelog
weiji14 Aug 31, 2023
aabf710
Update version info in CITATION.cff
weiji14 Aug 31, 2023
99b971f
Add full names of contributors to changelog
weiji14 Aug 31, 2023
c92613d
Add two highlight bullet points
weiji14 Aug 31, 2023
f4d6ca0
Rename PR #2585 to Add gallery example ... and resort order
weiji14 Aug 31, 2023
ea18595
Apply suggestions from code review
weiji14 Sep 1, 2023
6f1360a
Merge branch 'main' into changelog/v0.10.0
weiji14 Sep 1, 2023
f079908
Reorder some PRs in the enhancements and deprecations sections
weiji14 Sep 1, 2023
81dfe9d
Combine non-ASCII character PRs #2638 and #2584 into one highlight point
weiji14 Sep 1, 2023
6337593
Typo bracket
weiji14 Sep 1, 2023
a984cde
Apply suggestions from code review
weiji14 Sep 1, 2023
852b025
Swap author positions for Dongdong and Leo
weiji14 Sep 1, 2023
a8b8ae7
Add PR #2652 to changelog
weiji14 Sep 1, 2023
a7c3222
Use backticks around panel
weiji14 Sep 1, 2023
01a9764
Merge branch 'main' into changelog/v0.10.0
michaelgrund Sep 1, 2023
a45f323
Double quotes around incols
weiji14 Sep 1, 2023
144570c
Apply suggestions from code review
weiji14 Sep 1, 2023
f14c40a
Merge branch 'main' into changelog/v0.10.0
michaelgrund Sep 1, 2023
72db599
Apply suggestions from code review
weiji14 Sep 1, 2023
7ea7cfa
Change release date to 20230902
weiji14 Sep 2, 2023
b6100a3
Move Yvonne up a few spots
weiji14 Sep 2, 2023
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
View file
Open in desktop
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: 2023-03-31
doi: 10.5281/zenodo.7772533
date-released: 2023-09-01
weiji14 marked this conversation as resolved.
Show resolved Hide resolved
doi: 10.5281/zenodo.8303186
license: BSD-3-Clause
repository-code: https://github.com/GenericMappingTools/pygmt
type: software
weiji14 marked this conversation as resolved.
Show resolved Hide resolved
version: 0.9.0
version: 0.10.0
17 changes: 11 additions & 6 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ Developers". Feel free to cite our work in your research using the following Bib

.. code-block::

@software{pygmt_2023_7772533,
@software{pygmt_2023_8303186,
author = {Uieda, Leonardo and
Copy link
Member Author

Choose a reason for hiding this comment

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

Do we keep the same order list for the authors? Output of commits made on main branch at 1d8c0fd to first commit at e3c542a (git shortlog 1d8c0f...e3c542a -sne) shows this after I merge the same author names:

544  Dongdong Tian
255  Leonardo Uieda
216  Wei Ji
191  Will Schlitzer
169  dependabot[bot]
130  Yvonne Fröhlich
124  Michael Grund
109  Max Jones
 33  Yao Jiayuan
 15  Liam Toney
  7  yohaimagen
  4  Tong
  3  kmaterna
  2  Abhishek Anant
  2  Amanda Leaman
  2  Andre L. Belem
  2  Andrey Shmakov
  2  Claudio Satriano
  2  Conor Bacon
  2  Jamie J Quinn
  2  MichaeINeumann
  2  Noor Buchi
  2  Shivani chauhan
  2  Tyler Newton
  2  alperen-kilic
  2  carocamargo
  2  daroari
  2  obaney
  2  srijac
  1  Alicia Ngoc Diep Ha
  1  Andrés Ignacio Torres
  1  Becky Salvage
  1  Brook
  1  Cody Woodson
  1  Emily McMullan
  1  Jack Beagley
  1  Julius Busecke 
  1  Kadatatlu Kishore
  1  Loïc Houpert
  1  Malte Ziebarth
  1  Mark Wieczorek
  1  Philipp Loose
  1  Sean H
  1  Soham Banerjee
  1  Tawanda
  1  Vitor Gratiere Torres
  1  mdtanker
  1  shahid-0
  1  teriyakiSauce23

Copy link
Member

Choose a reason for hiding this comment

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

Based on the counts of commits, I think we should at least make two changes:

  1. Move "Yvonne Fröhlich" before "Michael Grund"
  2. Move "Yao Jiayuan" before "Liam Toney"

As for the order between Leo and me, I'm not sure about this, considering that Leo created this package.

Copy link
Member Author

Choose a reason for hiding this comment

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

Move "Yvonne Fröhlich" before "Michael Grund"

Ok with this. I've been meaning to ask @yvonnefroehlich if she would like to be a maintainer actually, she's been helping a lot with the documentation and doing a lot of good quality reviews lately.

Move "Yao Jiayuan" before "Liam Toney"

I don't think either of them have made a commit since 2021 (< v0.4.1), so not sure why we should change the order now... Liam did do quite a bit of work on the ROSES 2021 and 2020 videos, and I it was somewhat agreed at #1414 (comment) to keep the order this way?

As for the order between Leo and me, I'm not sure about this, considering that Leo created this package.

Leo said at #1594 (comment) that he was happy for you to go first, and I'd say you deserve it more now 🙂 But we can also leave it if you feel shy, and put your name first on the paper 😉

Copy link
Member

Choose a reason for hiding this comment

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

Move "Yvonne Fröhlich" before "Michael Grund"

Ok with this. I've been meaning to ask @yvonnefroehlich if she would like to be a maintainer actually, she's been helping a lot with the documentation and doing a lot of good quality reviews lately.

Yes, she's well qualified.

Move "Yao Jiayuan" before "Liam Toney"

I don't think either of them have made a commit since 2021 (< v0.4.1), so not sure why we should change the order now... Liam did do quite a bit of work on the ROSES 2021 and 2020 videos, and I it was somewhat agreed at #1414 (comment) to keep the order this way?

Sounds reasonable. Let's keep it unchanged.

As for the order between Leo and me, I'm not sure about this, considering that Leo created this package.

Leo said at #1594 (comment) that he was happy for you to go first, and I'd say you deserve it more now 🙂 But we can also leave it if you feel shy, and put your name first on the paper 😉

Aha, I didn't realize that. It's my honor to be listed as the first one. BTW, you're really good at digging history 😉

Copy link
Member Author

Choose a reason for hiding this comment

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

Ok, done at 852b025

Copy link
Member

Choose a reason for hiding this comment

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

Move "Yvonne Fröhlich" before "Michael Grund"

Ok with this. I've been meaning to ask @yvonnefroehlich if she would like to be a maintainer actually, she's been helping a lot with the documentation and doing a lot of good quality reviews lately.

Yes, she's well qualified.

First of all thanks a lot for this positive feedback, @weiji14 and @seisman 😊. I'm glad to hear this! I am really thankful for contributing to this project; I learned a lot. So, I would be pleased to become a maintainer of PyGMT. Hopefully the other @GenericMappingTools/pygmt-maintainers are also fine with this.
I feel I should have the time to help with the documentation and reviewing PRs in the future, but for more complicated code-related tasks I would need more (free) time, which is currently not very likely because of the workload of my PhD projects.

Just one comment regarding the commit list above: Looking at the commit numbers of the single contributors at https://github.com/GenericMappingTools/pygmt/graphs/contributors there is partly a significant difference to git shortlog 1d8c0f...e3c542a -sne (I can reproduce @weiji14 numbers). Looking at the total number of commits made so far to this repro, it seems that GitHub additionally includes / counts co-authorship?

Copy link
Member Author

Choose a reason for hiding this comment

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

Move "Yvonne Fröhlich" before "Michael Grund"

Ok with this. I've been meaning to ask @yvonnefroehlich if she would like to be a maintainer actually, she's been helping a lot with the documentation and doing a lot of good quality reviews lately.

Yes, she's well qualified.

First of all thanks a lot for this positive feedback, @weiji14 and @seisman 😊. I'm glad to hear this! I am really thankful for contributing to this project; I learned a lot. So, I would be pleased to become a maintainer of PyGMT. Hopefully the other @GenericMappingTools/pygmt-maintainers are also fine with this. I feel I should have the time to help with the documentation and reviewing PRs in the future, but for more complicated code-related tasks I would need more (free) time, which is currently not very likely because of the workload of my PhD projects.

No worries, feel free to help out as much (or as little) as you can, PhD comes first of course! If you can open up a PR to modify team.md, we can continue on from there.

Just one comment regarding the commit list above: Looking at the commit numbers of the single contributors at https://github.com/GenericMappingTools/pygmt/graphs/contributors there is partly a significant difference to git shortlog 1d8c0f...e3c542a -sne (I can reproduce @weiji14 numbers). Looking at the total number of commits made so far to this repro, it seems that GitHub additionally includes / counts co-authorship?

Yes, it might be that GitHub includes co-authored commits, whereas git log -sne only counts the main author.

Copy link
Member

Choose a reason for hiding this comment

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

No worries, feel free to help out as much (or as little) as you can, PhD comes first of course!

Sounds good 🙂!

If you can open up a PR to modify team.md, we can continue on from there.

Please see PR #2655.

Tian, Dongdong and
Leong, Wei Ji and
Expand All @@ -200,12 +200,12 @@ Developers". Feel free to cite our work in your research using the following Bib
Quinn, Jamie and
Wessel, Paul},
title = {{PyGMT: A Python interface for the Generic Mapping Tools}},
month = mar,
month = sep,
year = 2023,
publisher = {Zenodo},
version = {0.9.0},
doi = {10.5281/zenodo.7772533},
url = {https://doi.org/10.5281/zenodo.7772533}
version = {0.10.0},
doi = {10.5281/zenodo.8303186},
url = {https://doi.org/10.5281/zenodo.8303186}
}

To cite a specific version of PyGMT, go to our Zenodo page at
Expand Down Expand Up @@ -264,7 +264,12 @@ Compatibility with GMT/Python/NumPy versions
- >=6.3.0
- >=3.9
- >=1.22
* - `v0.9.0 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.9.0>`_ (latest release)
* - `v0.10.0 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.10.0>`_ (latest release)
- `v0.10.0 Documentation <https://www.pygmt.org/v0.10.0>`_
- >=6.3.0
- >=3.9
- >=1.22
* - `v0.9.0 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.9.0>`_
- `v0.9.0 Documentation <https://www.pygmt.org/v0.9.0>`_
- >=6.3.0
- >=3.8
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.10.0': 'v0.10.0',
'v0.9.0': 'v0.9.0',
'v0.8.0': 'v0.8.0',
'v0.7.0': 'v0.7.0',
Expand Down
90 changes: 90 additions & 0 deletions doc/changes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,95 @@
# Changelog

## Release v0.10.0 (2023/09/01)
weiji14 marked this conversation as resolved.
Show resolved Hide resolved

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

### Highlights

* 🎉 **Tenth minor release of PyGMT** 🎉
*
* Two new tutorials and seven new gallery examples
Copy link
Member Author

Choose a reason for hiding this comment

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

Suggestions for highlights?

Copy link
Member

Choose a reason for hiding this comment

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

Merge the two entries in the "New Features" category and move it to "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.

Ok, have combined the two non-ASCII character PRs into one highlight at 81dfe9d. Any other ones, or this is good enough?

Copy link
Member

@yvonnefroehlich yvonnefroehlich Sep 1, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Hm, a third highlight would be nice, but so far I don't have one 🙁. So, I am OK with two highlights.

weiji14 marked this conversation as resolved.
Show resolved Hide resolved

### New Features

* Support non-ASCII characters in function arguments ([#2584](https://github.com/GenericMappingTools/pygmt/pull/2584))
* Figure.text: Support non-ASCII characters in the 'text' parameter ([#2638](https://github.com/GenericMappingTools/pygmt/pull/2638))

### Enhancements

* Figure.colorbar: Add alias for "Q" ([#2608](https://github.com/GenericMappingTools/pygmt/pull/2608))
* Figure.image: Add alias for "G" ([#2615](https://github.com/GenericMappingTools/pygmt/pull/2615))
* Figure.meca: Add aliases for "L", "T", and "Fr" ([#2546](https://github.com/GenericMappingTools/pygmt/pull/2546))
weiji14 marked this conversation as resolved.
Show resolved Hide resolved
* pygmt.grdfill: Add alias for "N" ([#2618](https://github.com/GenericMappingTools/pygmt/pull/2618))
* pygmt.select: Add aliases for "C", "F", and "L" ([#2466(https://github.com/GenericMappingTools/pygmt/pull/2466)))
* Allow passing RGB xarray.DataArray images into grdimage ([#2590](https://github.com/GenericMappingTools/pygmt/pull/2590))
weiji14 marked this conversation as resolved.
Show resolved Hide resolved
* Better handling of optional virtual files (e.g., shading in Figure.grdimage) ([#2493](https://github.com/GenericMappingTools/pygmt/pull/2493))
* clib.Session: Wrap the GMT_Get_Common API function ([#2500](https://github.com/GenericMappingTools/pygmt/pull/2500))

### Deprecations

* Remove the deprecated incols parameter from Figure.text (deprecated since v0.8.0) ([#2473](https://github.com/GenericMappingTools/pygmt/pull/2473))
weiji14 marked this conversation as resolved.
Show resolved Hide resolved
* NEP29: Set minimum required version to Python 3.9+ ([#2487](https://github.com/GenericMappingTools/pygmt/pull/2487))
* NEP29: Set minimum required version to NumPy 1.22+ ([#2586](https://github.com/GenericMappingTools/pygmt/pull/2586))
* Figure.image: Deprecate parameter "bit_color" to "bitcolor" (remove in v0.12.0) ([#2635](https://github.com/GenericMappingTools/pygmt/pull/2635))

### Bug Fixes

* load_earth_mask: Keep data's encoding to correctly infer data's registration and gtype information ([#2632](https://github.com/GenericMappingTools/pygmt/pull/2632))
* geopandas: Mapping int/int64 to int32 for OGR_GMT format ([#2592](https://github.com/GenericMappingTools/pygmt/pull/2592))
weiji14 marked this conversation as resolved.
Show resolved Hide resolved
* Figure.meca: the 'scale' parameter can accept int/float/str values ([#2566](https://github.com/GenericMappingTools/pygmt/pull/2566))
weiji14 marked this conversation as resolved.
Show resolved Hide resolved
* Figure.meca: Fix beachball offsetting for ndarray input (requires GMT>=6.5.0) ([#2576](https://github.com/GenericMappingTools/pygmt/pull/2576))
weiji14 marked this conversation as resolved.
Show resolved Hide resolved

### Documentation

* Document the default CPT for GMT remote datasets ([#2573](https://github.com/GenericMappingTools/pygmt/pull/2573))
* Add tutorial to show interactive data visualization via 'panel' ([#2498](https://github.com/GenericMappingTools/pygmt/pull/2498))
weiji14 marked this conversation as resolved.
Show resolved Hide resolved
weiji14 marked this conversation as resolved.
Show resolved Hide resolved
* Add tutorial for cartesian histograms ([#2445](https://github.com/GenericMappingTools/pygmt/pull/2445))
* Add gallery example to show usage of dcw parameter in Figure.coast ([#2428](https://github.com/GenericMappingTools/pygmt/pull/2428))
* Add gallery example to show usage of tile maps ([#2585](https://github.com/GenericMappingTools/pygmt/pull/2585))
* Add gallery example showing how to build an envelope around a curve ([#2587](https://github.com/GenericMappingTools/pygmt/pull/2587))
weiji14 marked this conversation as resolved.
Show resolved Hide resolved
* Add gallery example for plotting an RGB image from an xarray.DataArray ([#2641](https://github.com/GenericMappingTools/pygmt/pull/2641))
* Add gallery example "Quoted lines" (`style="q"`) ([#2563](https://github.com/GenericMappingTools/pygmt/pull/2563))
* Add gallery example "Decorated lines" (`style="~"`) ([#2564](https://github.com/GenericMappingTools/pygmt/pull/2564))
* Add gallery example "Cross-section along a transect" ([#2515](https://github.com/GenericMappingTools/pygmt/pull/2515))

### Maintenance

* pygmt.show_versions: Show versions of IPython and rioxarray ([#2492](https://github.com/GenericMappingTools/pygmt/pull/2492))
weiji14 marked this conversation as resolved.
Show resolved Hide resolved
* Use substitutions to show the minimum required Python and GMT versions dynamically in installation guides ([#2488](https://github.com/GenericMappingTools/pygmt/pull/2488))
* Use np.asarray to convert a 1-D array to datetime type in array_to_datetime ([#2481](https://github.com/GenericMappingTools/pygmt/pull/2481))
* Use consistent docstrings for test files ([#2578](https://github.com/GenericMappingTools/pygmt/pull/2578))
* Use concurrency to cancel previous runs ([#2589](https://github.com/GenericMappingTools/pygmt/pull/2589))
* Set date_format to ISO8601 to silence pandas 2.0 UserWarning on read_csv ([#2569](https://github.com/GenericMappingTools/pygmt/pull/2569))
* Remove dummy_context and use contextlib.nullcontext instead ([#2491](https://github.com/GenericMappingTools/pygmt/pull/2491))
* NEP29: Test PyGMT on NumPy 1.25 ([#2581](https://github.com/GenericMappingTools/pygmt/pull/2581))
* Migrate provision-with-micromamba to setup-micromamba ([#2536](https://github.com/GenericMappingTools/pygmt/pull/2536))
weiji14 marked this conversation as resolved.
Show resolved Hide resolved
* Fix tests for Aug 2023 updated remote datasets ([#2636](https://github.com/GenericMappingTools/pygmt/pull/2636))
* Figure.meca: Refactor the two tests for offsetting beachballs ([#2572](https://github.com/GenericMappingTools/pygmt/pull/2572))
* Figure.meca: Refactor tests for plotting multiple focal mechanisms ([#2565](https://github.com/GenericMappingTools/pygmt/pull/2565))
* Figure.meca: Refactor tests for plotting a single focal mechanism ([#2533](https://github.com/GenericMappingTools/pygmt/pull/2533))
* Figure.meca: Add a test for passing event names via pandas.DataFrame ([#2582](https://github.com/GenericMappingTools/pygmt/pull/2582))
* Exclude bots from contributors in release drafter ([#2484](https://github.com/GenericMappingTools/pygmt/pull/2484))
* Exclude DVC files from source/binary distributions ([#2634](https://github.com/GenericMappingTools/pygmt/pull/2634))
* CI: Use mamba-org/provision-with-micromamba to setup micromamba ([#2435](https://github.com/GenericMappingTools/pygmt/pull/2435))
weiji14 marked this conversation as resolved.
Show resolved Hide resolved
* CI: Run dev tests on Scientific Python nightly wheels ([#2612](https://github.com/GenericMappingTools/pygmt/pull/2612))
* CI: Remove the deprecated cml-publish command from the dvc-diff workflow ([#2559](https://github.com/GenericMappingTools/pygmt/pull/2559))
* CI: Fix and simplify the dvc-diff workflow ([#2549](https://github.com/GenericMappingTools/pygmt/pull/2549))
* CI: Add the "Doctests" workflow to run doctests weekly ([#2456](https://github.com/GenericMappingTools/pygmt/pull/2456))
* CI: Add detailed descriptions in the workflow files and update maintainer guides ([#2496](https://github.com/GenericMappingTools/pygmt/pull/2496))
* Add private function _validate_data_input to validate input data ([#2595](https://github.com/GenericMappingTools/pygmt/pull/2595))

### 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)
* [Jing-Hui Tong](https://github.com/JingHuiTong)
* [Max Jones](https://github.com/maxrjones)

---

## Release v0.9.0 (2023/03/31)

[![Digital Object Identifier for PyGMT v0.9.0](https://zenodo.org/badge/DOI/10.5281/zenodo.7772533.svg)](https://doi.org/10.5281/zenodo.7772533)
Expand Down