From e59b954dd34497a75f5c2386a4419910b44555db Mon Sep 17 00:00:00 2001 From: Wei Ji <23487320+weiji14@users.noreply.github.com> Date: Sat, 2 Sep 2023 13:15:48 +1200 Subject: [PATCH] Changelog entry for v0.10.0 (#2651) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Tenth minor release of PyGMT. * Add changelog entry to version switcher * Update compatibility table * Update citation * Add draft changelog * Add full names of contributors to changelog * Add two highlight bullet points * Combine non-ASCII character PRs #2638 and #2584 into one highlight point * Swap author positions for Dongdong and Leo * Change release date to 20230902 * Move Yvonne up a few spots --------- Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com> Co-authored-by: Dongdong Tian Co-authored-by: Michael Grund <23025878+michaelgrund@users.noreply.github.com> --- CITATION.cff | 22 ++++----- README.rst | 23 +++++---- doc/_static/version_switch.js | 1 + doc/changes.md | 87 +++++++++++++++++++++++++++++++++++ 4 files changed, 113 insertions(+), 20 deletions(-) diff --git a/CITATION.cff b/CITATION.cff index 390d1e6f3a4..9c73143ac54 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -4,14 +4,14 @@ cff-version: 1.2.0 message: If you use this software, please cite it as follows. title: 'PyGMT: A Python interface for the Generic Mapping Tools' authors: -- given-names: Leonardo - family-names: Uieda - affiliation: University of Liverpool, United Kingdom - orcid: https://orcid.org/0000-0001-6123-9515 - given-names: Dongdong 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 @@ -20,6 +20,10 @@ authors: family-names: Schlitzer affiliation: Unaffiliated orcid: https://orcid.org/0000-0002-5843-2282 +- given-names: Yvonne + family-names: Fröhlich + affiliation: Karlsruhe Institute of Technology, Germany + orcid: https://orcid.org/0000-0002-8566-0619 - given-names: Michael family-names: Grund affiliation: SNP Innovation Lab GmbH, Germany @@ -28,10 +32,6 @@ authors: family-names: Jones affiliation: University of Hawaiʻi at Mānoa, USA orcid: https://orcid.org/0000-0003-0180-8928 -- given-names: Yvonne - family-names: Fröhlich - affiliation: Karlsruhe Institute of Technology, Germany - orcid: https://orcid.org/0000-0002-8566-0619 - given-names: Liam family-names: Toney affiliation: University of Alaska Fairbanks, USA @@ -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-02 +doi: 10.5281/zenodo.8303186 license: BSD-3-Clause repository-code: https://github.com/GenericMappingTools/pygmt type: software -version: 0.9.0 +version: 0.10.0 diff --git a/README.rst b/README.rst index 0f7b6f23c60..5319e8223cb 100644 --- a/README.rst +++ b/README.rst @@ -180,14 +180,14 @@ Developers". Feel free to cite our work in your research using the following Bib .. code-block:: - @software{pygmt_2023_7772533, - author = {Uieda, Leonardo and - Tian, Dongdong and + @software{pygmt_2023_8303186, + author = {Tian, Dongdong and + Uieda, Leonardo and Leong, Wei Ji and Schlitzer, William and + Fröhlich, Yvonne and Grund, Michael and Jones, Max and - Fröhlich, Yvonne and Toney, Liam and Yao, Jiayuan and Magen, Yohai and @@ -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 @@ -264,7 +264,12 @@ Compatibility with GMT/Python/NumPy versions - >=6.3.0 - >=3.9 - >=1.22 - * - `v0.9.0 `_ (latest release) + * - `v0.10.0 `_ (latest release) + - `v0.10.0 Documentation `_ + - >=6.3.0 + - >=3.9 + - >=1.22 + * - `v0.9.0 `_ - `v0.9.0 Documentation `_ - >=6.3.0 - >=3.8 diff --git a/doc/_static/version_switch.js b/doc/_static/version_switch.js index f1a47c88af8..6218b013d87 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.10.0': 'v0.10.0', 'v0.9.0': 'v0.9.0', 'v0.8.0': 'v0.8.0', 'v0.7.0': 'v0.7.0', diff --git a/doc/changes.md b/doc/changes.md index 51a08a27eeb..3674af83f50 100644 --- a/doc/changes.md +++ b/doc/changes.md @@ -1,5 +1,92 @@ # Changelog +## Release v0.10.0 (2023/09/02) + +[![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** 🎉 +* Support non-ASCII characters in Figure.text ([#2638](https://github.com/GenericMappingTools/pygmt/pull/2638)) and other method arguments ([#2584](https://github.com/GenericMappingTools/pygmt/pull/2584)) +* Three new tutorials and seven new gallery examples + +### Enhancements + +* Figure.colorbar: Add alias for "Q" ([#2608](https://github.com/GenericMappingTools/pygmt/pull/2608)) +* Figure.grdimage: Allow passing RGB xarray.DataArray images ([#2590](https://github.com/GenericMappingTools/pygmt/pull/2590)) +* 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)) +* clib.Session: Wrap the GMT_Get_Common API function ([#2500](https://github.com/GenericMappingTools/pygmt/pull/2500)) +* 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)) +* pygmt.show_versions: Show versions of IPython and rioxarray ([#2492](https://github.com/GenericMappingTools/pygmt/pull/2492)) +* Better handling of optional virtual files (e.g., shading in Figure.grdimage) ([#2493](https://github.com/GenericMappingTools/pygmt/pull/2493)) + +### Deprecations + +* Remove the unused pygmt.test() function ([#2652](https://github.com/GenericMappingTools/pygmt/pull/2652)) +* Figure.image: Deprecate parameter "bit_color" to "bitcolor" (remove in v0.12.0) ([#2635](https://github.com/GenericMappingTools/pygmt/pull/2635)) +* Figure.text: Remove the deprecated "incols" parameter (deprecated since v0.8.0) ([#2473](https://github.com/GenericMappingTools/pygmt/pull/2473)) +* 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)) + +### 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 integration: Mapping int/int64 to int32 for OGR_GMT format ([#2592](https://github.com/GenericMappingTools/pygmt/pull/2592)) +* Figure.meca: Let the "scale" parameter accept int/float/str values ([#2566](https://github.com/GenericMappingTools/pygmt/pull/2566)) +* Figure.meca: Fix beachball offsetting for ndarray input (requires GMT>6.4.0) ([#2576](https://github.com/GenericMappingTools/pygmt/pull/2576)) + +### Documentation + +* Document the default CPT for GMT remote datasets ([#2573](https://github.com/GenericMappingTools/pygmt/pull/2573)) +* Add tutorial to explain naming of PyGMT figure elements ([#2383](https://github.com/GenericMappingTools/pygmt/pull/2383)) +* Add tutorial to show interactive data visualization via `panel` ([#2498](https://github.com/GenericMappingTools/pygmt/pull/2498)) +* 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)) +* 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 + +* 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)) +* 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)) +* CI: Migrate provision-with-micromamba to setup-micromamba ([#2536](https://github.com/GenericMappingTools/pygmt/pull/2536)) +* 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)