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.9.0 #2469

Merged
merged 14 commits into from
Mar 31, 2023
26 changes: 15 additions & 11 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,6 @@ authors:
family-names: Leong
affiliation: Development Seed, USA
orcid: https://orcid.org/0000-0003-2354-1988
- given-names: Max
family-names: Jones
affiliation: University of Hawai'i at Mānoa, USA
orcid: https://orcid.org/0000-0003-0180-8928
- given-names: William
family-names: Schlitzer
affiliation: Unaffiliated
Expand All @@ -28,14 +24,18 @@ authors:
family-names: Grund
affiliation: Innoplexia GmbH, Germany
orcid: https://orcid.org/0000-0001-8759-2018
- given-names: Liam
family-names: Toney
affiliation: University of Alaska Fairbanks, USA
orcid: https://orcid.org/0000-0003-0167-9433
- given-names: Max
family-names: Jones
affiliation: University of Hawai'i at Mānoa, USA
maxrjones marked this conversation as resolved.
Show resolved Hide resolved
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
orcid: https://orcid.org/0000-0003-0167-9433
- given-names: Jiayuan
family-names: Yao
affiliation: Nanyang Technological University, Singapore
Expand All @@ -44,6 +44,10 @@ authors:
family-names: Magen
affiliation: Tel Aviv University, Israel
orcid: https://orcid.org/0000-0002-4892-4013
- given-names: Tong
family-names: Jing-Hui
affiliation: National Taiwan Normal University, Taiwan
orcid: https://orcid.org/0009-0002-7195-3071
- given-names: Kathryn
family-names: Materna
affiliation: US Geological Survey, USA
Expand Down Expand Up @@ -72,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: 2022-12-30
doi: 10.5281/zenodo.7481934
date-released: 2023-03-31
doi: 10.5281/zenodo.7772533
license: BSD-3-Clause
repository-code: https://github.com/GenericMappingTools/pygmt
type: software
version: 0.8.0
version: 0.9.0
29 changes: 18 additions & 11 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -180,17 +180,18 @@ Developers". Feel free to cite our work in your research using the following Bib

.. code-block::

@software{pygmt_2022_7481934,
@software{pygmt_2023_7772533,
author = {Uieda, Leonardo and
Tian, Dongdong and
Leong, Wei Ji and
Jones, Max and
Schlitzer, William and
Grund, Michael and
Toney, Liam and
Jones, Max and
Fröhlich, Yvonne and
Toney, Liam and
Yao, Jiayuan and
Magen, Yohai and
Tong, Jing-Hui and
Materna, Kathryn and
Belem, Andre and
Newton, Tyler and
Expand All @@ -199,20 +200,21 @@ 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 = dec,
year = 2022,
month = mar,
year = 2023,
publisher = {Zenodo},
version = {0.8.0},
doi = {10.5281/zenodo.7481934},
url = {https://doi.org/10.5281/zenodo.7481934}
version = {0.9.0},
doi = {10.5281/zenodo.7772533},
url = {https://doi.org/10.5281/zenodo.7772533}
}

To cite a specific version of PyGMT, go to our Zenodo page at
maxrjones marked this conversation as resolved.
Show resolved Hide resolved
https://doi.org/10.5281/zenodo.3781524 and use the "Export to BibTeX" function there.
It is also strongly recommended to cite the
`GMT6 paper <https://doi.org/10.1029/2019GC008515>`__ (which PyGMT wraps around).
Note that some modules like ``surface`` and ``x2sys`` also have their dedicated citation.
Further information for all these can be found at https://www.generic-mapping-tools.org/cite.
Note that some modules like ``dimfilter``, ``surface`` and ``x2sys`` also have their
maxrjones marked this conversation as resolved.
Show resolved Hide resolved
dedicated citation. Further information for all these can be found at
https://www.generic-mapping-tools.org/cite.


License
Expand Down Expand Up @@ -262,7 +264,12 @@ Compatibility with GMT/Python/NumPy versions
- >=6.3.0
- >=3.8
- >=1.21
* - `v0.8.0 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.8.0>`_ (latest release)
* - `v0.9.0 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.9.0>`_ (latest release)
- `v0.9.0 Documentation <https://www.pygmt.org/v0.9.0>`_
- >=6.3.0
- >=3.8
- >=1.21
* - `v0.8.0 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.8.0>`_
- `v0.8.0 Documentation <https://www.pygmt.org/v0.8.0>`_
- >=6.3.0
- >=3.8
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.9.0': 'v0.9.0',
'v0.8.0': 'v0.8.0',
'v0.7.0': 'v0.7.0',
'v0.6.1': 'v0.6.1',
Expand Down
86 changes: 86 additions & 0 deletions doc/changes.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,91 @@
# Changelog

## Release v0.9.0 (20YY/03/31)
seisman marked this conversation as resolved.
Show resolved Hide resolved

[![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)

### Highlights

* 🎉 **Ninth minor release of PyGMT** 🎉
* Add function to load raster tile maps using contextily ([#2125](https://github.com/GenericMappingTools/pygmt/pull/2125))
maxrjones marked this conversation as resolved.
Show resolved Hide resolved
* Add Figure.tilemap to plot XYZ tile maps ([#2394](https://github.com/GenericMappingTools/pygmt/pull/2394))
maxrjones marked this conversation as resolved.
Show resolved Hide resolved

### New Features

* Add load_earth_mask function for GSHHG Global Earth Mask dataset ([#2310](https://github.com/GenericMappingTools/pygmt/pull/2310))
* Add Figure.timestamp to plot the GMT timestamp logo ([#2208](https://github.com/GenericMappingTools/pygmt/pull/2208))

### Enhancements

* pygmt.surface: Add aliases for "C", "L", "M", and "T" ([#2321](https://github.com/GenericMappingTools/pygmt/pull/2321))
* Figure.timestamp: Let the 'text' parameter work for GMT<=6.4.0 and raise a warning for long text ([#2425](https://github.com/GenericMappingTools/pygmt/pull/2425))
maxrjones marked this conversation as resolved.
Show resolved Hide resolved
* Figure.meca: Add aliases for C, E, G, and W ([#2345](https://github.com/GenericMappingTools/pygmt/pull/2345))
* Figure.colorbar: Add aliases for L and Z ([#2357](https://github.com/GenericMappingTools/pygmt/pull/2357))
* Expand Colorbar gallery example for categorical data ([#2395](https://github.com/GenericMappingTools/pygmt/pull/2395))
maxrjones marked this conversation as resolved.
Show resolved Hide resolved

### Deprecations

* NEP29: Set minimum required version to NumPy 1.21+ ([#2389](https://github.com/GenericMappingTools/pygmt/pull/2389))
* Recommend Figure.timestamp and remove timestamp (U) alias from all plotting methods ([#2135](https://github.com/GenericMappingTools/pygmt/pull/2135))
* Remove the deprecated load_fractures_compilation function (deprecated since v0.6.0) ([#2303](https://github.com/GenericMappingTools/pygmt/pull/2303))
* Remove the deprecated load_hotspots function (deprecated since v0.6.0) ([#2309](https://github.com/GenericMappingTools/pygmt/pull/2309))
* Remove the deprecated load_japan_quakes function (deprecated since v0.6.0) ([#2301](https://github.com/GenericMappingTools/pygmt/pull/2301))
* Remove the deprecated load_mars_shape function (deprecated since v0.6.0) ([#2304](https://github.com/GenericMappingTools/pygmt/pull/2304))
* Remove the deprecated load_ocean_ridge_points function (deprecated since v0.6.0) ([#2308](https://github.com/GenericMappingTools/pygmt/pull/2308))
* Remove the deprecated load_sample_bathymetry function (deprecated since v0.6.0) ([#2305](https://github.com/GenericMappingTools/pygmt/pull/2305))
* Remove the deprecated load_usgs_quakes function (deprecated since v0.6.0) ([#2306](https://github.com/GenericMappingTools/pygmt/pull/2306))
* pygmt.grdtrack: Remove the warning about the incorrect parameter order of 'points, grid' (warned since v0.7.0) ([#2312](https://github.com/GenericMappingTools/pygmt/pull/2312))

### Bug Fixes

* GMTDataArrayAccessor: Fallback to default grid registration and gtype if the grid source file doesn't exist ([#2009](https://github.com/GenericMappingTools/pygmt/pull/2009))
* Fix setting "sharex", "sharey", and "frame" of Figure.subplot in combination with Figure.basemap ([#2417](https://github.com/GenericMappingTools/pygmt/pull/2417))
* Fix bug with different band dtype from load_tile_map by casting to uint8 ([#2393](https://github.com/GenericMappingTools/pygmt/pull/2393))
maxrjones marked this conversation as resolved.
Show resolved Hide resolved
* Figure.subplot: Fix strange positioning issues after exiting subplot ([#2427](https://github.com/GenericMappingTools/pygmt/pull/2427))
* pygmt.config: Correctly resetting to default values that contain whitespaces ([#2331](https://github.com/GenericMappingTools/pygmt/pull/2331))
maxrjones marked this conversation as resolved.
Show resolved Hide resolved
* pygmt.set_display: Do nothing when the display method is set to 'none' ([#2450](https://github.com/GenericMappingTools/pygmt/pull/2450))

### Documentation

* GMTDataArrayAccessor: Add inline examples for setting GMT specific properties (#2370) ([#2370](https://github.com/GenericMappingTools/pygmt/pull/2370))
maxrjones marked this conversation as resolved.
Show resolved Hide resolved
* Document limitations of GMT xarray accessors ([#2375](https://github.com/GenericMappingTools/pygmt/pull/2375))
* Revise the notes about registration and gtype of remote datasets ([#2384](https://github.com/GenericMappingTools/pygmt/pull/2384))
* Add project keywords to the pyproject.toml file ([#2315](https://github.com/GenericMappingTools/pygmt/pull/2315))
* Add inline example for colorbar ([#2373](https://github.com/GenericMappingTools/pygmt/pull/2373))
* Add inline example for grdview ([#2381](https://github.com/GenericMappingTools/pygmt/pull/2381))
* Add inline example for load_earth_mask ([#2355](https://github.com/GenericMappingTools/pygmt/pull/2355))
* Add inline example for load_earth_vertical_gravity_gradient ([#2356](https://github.com/GenericMappingTools/pygmt/pull/2356))
* Add inline examples and improve documentation for pygmt.set_display ([#2458](https://github.com/GenericMappingTools/pygmt/pull/2458))
* Add gallery example showing how to use patterns via the "fill" parameter (or similiar parameters) ([#2329](https://github.com/GenericMappingTools/pygmt/pull/2329))
maxrjones marked this conversation as resolved.
Show resolved Hide resolved
* Add gallery example for scatter plot with histograms on sides ([#2410](https://github.com/GenericMappingTools/pygmt/pull/2410))
* Add gallery example showing how to use advanced grdgradient via the "azimuth" & "normalize" parameters ([#2354](https://github.com/GenericMappingTools/pygmt/pull/2354))
* Add gallery example for the Figure.timestamp method ([#2391](https://github.com/GenericMappingTools/pygmt/pull/2391))
* Expand gallery example "Focal mechanisms" to use "*fill" and "pen" ([#2433](https://github.com/GenericMappingTools/pygmt/pull/2433))
maxrjones marked this conversation as resolved.
Show resolved Hide resolved
* Add working example to quickstart section of README ([#2369](https://github.com/GenericMappingTools/pygmt/pull/2369))
* Recommend Mambaforge and mamba in the installation and contributing guides ([#2385](https://github.com/GenericMappingTools/pygmt/pull/2385))

### Maintenance

* Add the GMTSampleData class to simplify the load_sample_data and list_sample_data functions (#2342) ([#2342](https://github.com/GenericMappingTools/pygmt/pull/2342))
maxrjones marked this conversation as resolved.
Show resolved Hide resolved
* Add a new target 'doctest' to run doctests only and simplify Makefile ([#2443](https://github.com/GenericMappingTools/pygmt/pull/2443))
* Add a package-level variable __gmt_version__ for development use ([#2366](https://github.com/GenericMappingTools/pygmt/pull/2366))
maxrjones marked this conversation as resolved.
Show resolved Hide resolved
* Allow printing show_versions() to in-memory buffer to enable testing ([#2399](https://github.com/GenericMappingTools/pygmt/pull/2399))
* Accept a dict containing configurable GMT parameters in build_arg_string ([#2324](https://github.com/GenericMappingTools/pygmt/pull/2324))
* Publish to TestPyPI and PyPI via OpenID Connect token ([#2453](https://github.com/GenericMappingTools/pygmt/pull/2453))
* Remove --sdist --wheel flags from the build command ([#2420](https://github.com/GenericMappingTools/pygmt/pull/2420))
* Replace ModuleNotFoundError with the more general ImportError ([#2441](https://github.com/GenericMappingTools/pygmt/pull/2441))

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

---

## Release v0.8.0 (2022/12/30)

Expand Down