From 662e13285c6c09f486b76dfa57c5ab550153805f Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Sat, 19 Jun 2021 16:20:04 -0400 Subject: [PATCH 01/26] Changelog entry for v0.4.0 --- doc/changes.md | 112 ++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 111 insertions(+), 1 deletion(-) diff --git a/doc/changes.md b/doc/changes.md index afaf1402e21..ffd32024718 100644 --- a/doc/changes.md +++ b/doc/changes.md @@ -1,4 +1,114 @@ -# Changelog +## Release v0.4.0 (20YY/MM/DD) + +[![Digital Object Identifier for PyGMT v0.4.0](https://zenodo.org/badge/DOI/10.5281/zenodo.3781524.svg)](https://doi.org/10.5281/zenodo.3781524) + +### Highlights + +* + +### New Features + +* Wrap grdlandmask ([#1273](https://github.com/GenericMappingTools/pygmt/pull/1273)) +* Wrap grdgradient ([#1269](https://github.com/GenericMappingTools/pygmt/pull/1269)) +* Wrap grdfill ([#1276](https://github.com/GenericMappingTools/pygmt/pull/1276)) +* Wrap grdclip ([#1261](https://github.com/GenericMappingTools/pygmt/pull/1261)) +* Handle geopandas and shapely geometries via geo_interface link ([#1000](https://github.com/GenericMappingTools/pygmt/pull/1000)) +* Wrap velo ([#525](https://github.com/GenericMappingTools/pygmt/pull/525)) +* Wrap histogram ([#1072](https://github.com/GenericMappingTools/pygmt/pull/1072)) +* Wrap wiggle ([#1145](https://github.com/GenericMappingTools/pygmt/pull/1145)) +* Support passing string type numbers, geographic coordinates and datetimes ([#975](https://github.com/GenericMappingTools/pygmt/pull/975)) +* Wrap rose ([#794](https://github.com/GenericMappingTools/pygmt/pull/794)) +* Wrap solar ([#804](https://github.com/GenericMappingTools/pygmt/pull/804)) +* Wrap blockmean ([#1092](https://github.com/GenericMappingTools/pygmt/pull/1092)) +* Allow load_earth_relief() to load the original land-only 01s or 03s SRTM tiles ([#976](https://github.com/GenericMappingTools/pygmt/pull/976)) + +### Enhancements + +* Allow x/y/z input for blockmedian and blockmean ([#1319](https://github.com/GenericMappingTools/pygmt/pull/1319)) +* Support tab completion in Jupyter by inserting aliases into the method signature ([#1282](https://github.com/GenericMappingTools/pygmt/pull/1282)) +* Allow passing xr.DataArray as shading to grdimage ([#750](https://github.com/GenericMappingTools/pygmt/pull/750)) +* Allow pygmt.which to accept a list of filenames as input ([#1312](https://github.com/GenericMappingTools/pygmt/pull/1312)) +* Let Figure.savefig recommend .eps or .pdf when .ps extension is used ([#1307](https://github.com/GenericMappingTools/pygmt/pull/1307)) +* Add incols to COMMON_OPTIONS, blockmean, and blockmedian ([#1300](https://github.com/GenericMappingTools/pygmt/pull/1300)) +* Refactor blockm* to use virtualfile_from_data and improve i/o ([#1280](https://github.com/GenericMappingTools/pygmt/pull/1280)) +* Add parameters to histogram ([#1249](https://github.com/GenericMappingTools/pygmt/pull/1249)) +* Refactor grdtrack to use virtualfile_from_data and improve i/o to pandas.DataFrame ([#1189](https://github.com/GenericMappingTools/pygmt/pull/1189)) +* Improve Figure.show for displaying previews in Jupyter notebooks and external viewers ([#529](https://github.com/GenericMappingTools/pygmt/pull/529)) +* Allow passing an array as intensity for plot3d ([#1109](https://github.com/GenericMappingTools/pygmt/pull/1109)) +* Allow passing an array as intensity for plot ([#1065](https://github.com/GenericMappingTools/pygmt/pull/1065)) +* Add alias 'aspatial' to methods blockmedian, info, plot, plot3d, surface ([#1090](https://github.com/GenericMappingTools/pygmt/pull/1090)) +* Add alias 'registration' to methods blockmean, info, grdfilter, surface ([#1089](https://github.com/GenericMappingTools/pygmt/pull/1089)) + +### Deprecations + +* Figure.plot3d: Deprecate parameter "columns" to "incols" (remove in v0.6.0) ([#1040](https://github.com/GenericMappingTools/pygmt/pull/1040)) +* Raise a warning for the use of short-form parameters when long-forms are available ([#1316](https://github.com/GenericMappingTools/pygmt/pull/1316)) +* Figure.contour: Deprecate parameter "columns" to "incols" (remove in v0.6.0) ([#1303](https://github.com/GenericMappingTools/pygmt/pull/1303)) +* Figure.rose: Deprecate parameter "columns" to "incols" (remove in v0.6.0) ([#1306](https://github.com/GenericMappingTools/pygmt/pull/1306)) +* Figure.plot: Deprecate parameter "columns" to "incols" (remove in v0.6.0) ([#1298](https://github.com/GenericMappingTools/pygmt/pull/1298)) +* Figure.plot3d: Deprecate parameter "sizes" to "size" (remove in v0.6.0) ([#1258](https://github.com/GenericMappingTools/pygmt/pull/1258)) +* Figure.plot: Deprecate parameter "sizes" to "size" (remove in v0.6.0) ([#1254](https://github.com/GenericMappingTools/pygmt/pull/1254)) +* NEP29: Set minimum required versions to NumPy 1.17+ and Python 3.7+ ([#1074](https://github.com/GenericMappingTools/pygmt/pull/1074)) + +### Bug Fixes + +* Let Figure.savefig support filenames with spaces ([#1116](https://github.com/GenericMappingTools/pygmt/pull/1116)) +* Explicitly use netcdf4 engine in xarray.open_dataarray to read grd files ([#1264](https://github.com/GenericMappingTools/pygmt/pull/1264)) +* Fixed typo of "projecton" to "projection" in subplot module. ([#1214](https://github.com/GenericMappingTools/pygmt/pull/1214)) +* Let Figure.show(method='external') work well in Python scripts ([#1062](https://github.com/GenericMappingTools/pygmt/pull/1062)) + +### Documentation + +* Move contributing guide details to website and rename two sections ([#1335](https://github.com/GenericMappingTools/pygmt/pull/1335)) +* Add a tutorial for datetime data ([#1193](https://github.com/GenericMappingTools/pygmt/pull/1193)) +* Complete documentation for grdtrack ([#1190](https://github.com/GenericMappingTools/pygmt/pull/1190)) +* Add guidelines for managing issues to maintenance.md ([#1301](https://github.com/GenericMappingTools/pygmt/pull/1301)) +* Update the inset gallery example ([#1287](https://github.com/GenericMappingTools/pygmt/pull/1287)) +* Clarify position of deprecate_parameter decorator to be above use_alias ([#1302](https://github.com/GenericMappingTools/pygmt/pull/1302)) +* Add projection and region to grdview docstring ([#1295](https://github.com/GenericMappingTools/pygmt/pull/1295)) +* Add common alias spacing (-I) for specifying grid increments ([#1288](https://github.com/GenericMappingTools/pygmt/pull/1288)) +* Revise Pull Request review process in CONTRIBUTING.md ([#1119](https://github.com/GenericMappingTools/pygmt/pull/1119)) +* Clarify that the "transparency" parameter in plot/plot3d/text can be 1d array ([#1265](https://github.com/GenericMappingTools/pygmt/pull/1265)) +* Add histogram gallery example ([#1272](https://github.com/GenericMappingTools/pygmt/pull/1272)) +* Standardize docstrings for table-like inputs ([#1186](https://github.com/GenericMappingTools/pygmt/pull/1186)) +* Add categorical colorbars for plot, plot3d and line colors gallery examples ([#1267](https://github.com/GenericMappingTools/pygmt/pull/1267)) +* Clarify that the "color" parameter in plot/plot3d can be 1d array ([#1260](https://github.com/GenericMappingTools/pygmt/pull/1260)) +* Added documentation for three oblique mercator projections ([#1251](https://github.com/GenericMappingTools/pygmt/pull/1251)) +* Add alias name convention to CONTRIBUTING.md ([#1256](https://github.com/GenericMappingTools/pygmt/pull/1256)) +* Add a list of external PyGMT resources ([#1210](https://github.com/GenericMappingTools/pygmt/pull/1210)) +* Add a gallery example showing individual basic geometric symbols ([#1211](https://github.com/GenericMappingTools/pygmt/pull/1211)) +* Remove the "full test" section from installation guide ([#1206](https://github.com/GenericMappingTools/pygmt/pull/1206)) +* Apply NIST SI unit convention to some gallery examples ([#1194](https://github.com/GenericMappingTools/pygmt/pull/1194)) +* Use colorblind-friendly colors in the scatter plots gallery example ([#1013](https://github.com/GenericMappingTools/pygmt/pull/1013)) +* [Fix]: warning in building the documentation ([#1178](https://github.com/GenericMappingTools/pygmt/pull/1178)) +* Add a tutorial for plotting vectors ([#1070](https://github.com/GenericMappingTools/pygmt/pull/1070)) +* Clarify interplay of spacing and per_column in info ([#1127](https://github.com/GenericMappingTools/pygmt/pull/1127)) +* Update the check_figures_equal testing section in CONTRIBUTING.md ([#1108](https://github.com/GenericMappingTools/pygmt/pull/1108)) + +### Maintenance + +* Reinstall optional geopandas dependency on CI tests ([#1331](https://github.com/GenericMappingTools/pygmt/pull/1331)) +* Fix rose tests for GMT 6.2.0 ([#1324](https://github.com/GenericMappingTools/pygmt/pull/1324)) +* Add a workflow to upload baseline images as a release asset ([#1317](https://github.com/GenericMappingTools/pygmt/pull/1317)) +* Bump the minimum required GMT version to 6.2.0 ([#1321](https://github.com/GenericMappingTools/pygmt/pull/1321)) +* Add regression test for grdimage plotting an xarray.DataArray grid subset ([#1314](https://github.com/GenericMappingTools/pygmt/pull/1314)) +* Add download_test_data to download data files used in tests ([#1310](https://github.com/GenericMappingTools/pygmt/pull/1310)) +* Update fig.basemap, fig.subplot and fig.wiggle baseline images for GMT 6.2.0rc2 ([#1291](https://github.com/GenericMappingTools/pygmt/pull/1291)) +* Remove xfails and workarounds for datetime inputs into pygmt.info ([#1236](https://github.com/GenericMappingTools/pygmt/pull/1236)) +* Improve the DVC image diff workflow to support side-by-side comparison of modified images ([#1219](https://github.com/GenericMappingTools/pygmt/pull/1219)) +* Document the deprecation policy and addd the deprecate_parameter decorator to deprecate parameters ([#1160](https://github.com/GenericMappingTools/pygmt/pull/1160)) +* Convert booleans arguments in build_arg_string, not in kwargs_to_strings ([#1125](https://github.com/GenericMappingTools/pygmt/pull/1125)) +* Create Github Action workflow for reporting DVC image diffs ([#1104](https://github.com/GenericMappingTools/pygmt/pull/1104)) +* Add new function to load fractures sample data ([#1101](https://github.com/GenericMappingTools/pygmt/pull/1101)) +* Update "GMT Dev Tests" workflow to test macOS-11.0 and pre-release Python packages ([#1105](https://github.com/GenericMappingTools/pygmt/pull/1105)) +* Initialize data version control for managing test images ([#1036](https://github.com/GenericMappingTools/pygmt/pull/1036)) +* Separate workflows for running tests and building documentation ([#1033](https://github.com/GenericMappingTools/pygmt/pull/1033)) + +### Contributors + +@Lawqup, @MichaeINeumann, @alperen-kilic, @core-man, @dependabot, @dependabot[bot], @eemcmullan, @itsabhianant, @lhoupert, @mdtanker, @meghanrjones, @michaelgrund, @noorbuchi, @seisman, @shahid-0, @vitorgt, @weiji14, @willschlitzer and @xdshivani + +---- ## Release v0.3.1 (2021/03/14) From 6c801f4b3260af8a82354a2cf2ade1d99d59bf1f Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Sat, 19 Jun 2021 16:22:37 -0400 Subject: [PATCH 02/26] Add header back --- doc/changes.md | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/changes.md b/doc/changes.md index ffd32024718..4a241524238 100644 --- a/doc/changes.md +++ b/doc/changes.md @@ -1,3 +1,4 @@ +# Changelog ## Release v0.4.0 (20YY/MM/DD) [![Digital Object Identifier for PyGMT v0.4.0](https://zenodo.org/badge/DOI/10.5281/zenodo.3781524.svg)](https://doi.org/10.5281/zenodo.3781524) From 2c01a199abccf88c48a93d68d80e128a2c668ff2 Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Sat, 19 Jun 2021 16:23:15 -0400 Subject: [PATCH 03/26] Update DOI --- doc/changes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/changes.md b/doc/changes.md index 4a241524238..0c048b66e69 100644 --- a/doc/changes.md +++ b/doc/changes.md @@ -1,7 +1,7 @@ # Changelog ## Release v0.4.0 (20YY/MM/DD) -[![Digital Object Identifier for PyGMT v0.4.0](https://zenodo.org/badge/DOI/10.5281/zenodo.3781524.svg)](https://doi.org/10.5281/zenodo.3781524) +[![Digital Object Identifier for PyGMT v0.4.0](https://zenodo.org/badge/DOI/10.5281/zenodo.3781524.svg)](https://doi.org/10.5281/zenodo.4978645) ### Highlights From db50363b601874191b705e2d20bb0d03e4253882 Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Sat, 19 Jun 2021 16:34:39 -0400 Subject: [PATCH 04/26] Update version_switch.js --- doc/_static/version_switch.js | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/_static/version_switch.js b/doc/_static/version_switch.js index 87109898fc4..33d4af5c385 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.4.0': 'v0.4.0', 'v0.3.1': 'v0.3.1', 'v0.3.0': 'v0.3.0', 'v0.2.1': 'v0.2.1', From 134f9c5c00faac9b1f76db97f836042ee0592c1b Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Sat, 19 Jun 2021 19:02:15 -0400 Subject: [PATCH 05/26] Update citation metadata --- README.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 253a367b873..b062628f344 100644 --- a/README.rst +++ b/README.rst @@ -154,7 +154,7 @@ Developers". Feel free to cite our work in your research using the following Bib .. code-block:: - @software{pygmt_2021_4592991, + @software{pygmt_2021_4978645, author = {Uieda, Leonardo and Tian, Dongdong and Leong, Wei Ji and @@ -168,12 +168,12 @@ Developers". Feel free to cite our work in your research using the following Bib Ziebarth, Malte and Wessel, Paul}, title = {{PyGMT: A Python interface for the Generic Mapping Tools}}, - month = mar, + month = jun, year = 2021, publisher = {Zenodo}, - version = {v0.3.1}, - doi = {10.5281/zenodo.4592991}, - url = {https://doi.org/10.5281/zenodo.4592991} + version = {v0.4.0}, + doi = {10.5281/zenodo.4978645}, + url = {https://doi.org/10.5281/zenodo.4978645} } To cite a specific version of PyGMT, go to our Zenodo page at From f54eeed4f2c73354932d4cc256412e6f1fe6539c Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Sat, 19 Jun 2021 19:02:57 -0400 Subject: [PATCH 06/26] Update documentation for other versions section --- README.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/README.rst b/README.rst index b062628f344..c22fc28bd01 100644 --- a/README.rst +++ b/README.rst @@ -220,6 +220,7 @@ Documentation for other versions * `Development `__ (reflects the *master* branch on GitHub) * `Latest release `__ +* `v0.4.0 `__ * `v0.3.1 `__ * `v0.3.0 `__ * `v0.2.1 `__ From 5d9e190a298e760631640158ded271acd87110a7 Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Sat, 19 Jun 2021 19:03:44 -0400 Subject: [PATCH 07/26] Update compatability section --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index c22fc28bd01..9fc54181377 100644 --- a/README.rst +++ b/README.rst @@ -236,7 +236,7 @@ Compatibility with GMT and Python/NumPy versions ======= ========== ========= ========= PyGMT GMT Python NumPy ======= ========== ========= ========= -0.4.x >=6.2.0 >=3.7 >=1.17.0 +0.4.0 >=6.2.0 >=3.7 >=1.17.0 0.3.x >=6.1.1 >=3.7 0.2.1 >=6.1.1 >=3.6 0.2.0 >=6.1.1 3.6 - 3.8 From c27b43b52a92989df73b92bfbe54afa6c07e1ff2 Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Sat, 19 Jun 2021 19:14:16 -0400 Subject: [PATCH 08/26] Add PR #1325 --- doc/changes.md | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/changes.md b/doc/changes.md index 0c048b66e69..eab99576c29 100644 --- a/doc/changes.md +++ b/doc/changes.md @@ -60,6 +60,7 @@ ### Documentation +* Specify rectangle's width and height via style parameter in multi-parameter symbols example ([#1325](https://github.com/GenericMappingTools/pygmt/pull/1325)) * Move contributing guide details to website and rename two sections ([#1335](https://github.com/GenericMappingTools/pygmt/pull/1335)) * Add a tutorial for datetime data ([#1193](https://github.com/GenericMappingTools/pygmt/pull/1193)) * Complete documentation for grdtrack ([#1190](https://github.com/GenericMappingTools/pygmt/pull/1190)) From 7cf46138a92567a50ed3a255642308bc3cbbdb86 Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Sat, 19 Jun 2021 19:18:15 -0400 Subject: [PATCH 09/26] Remove typo PR --- doc/changes.md | 1 - 1 file changed, 1 deletion(-) diff --git a/doc/changes.md b/doc/changes.md index eab99576c29..48266176c32 100644 --- a/doc/changes.md +++ b/doc/changes.md @@ -82,7 +82,6 @@ * Remove the "full test" section from installation guide ([#1206](https://github.com/GenericMappingTools/pygmt/pull/1206)) * Apply NIST SI unit convention to some gallery examples ([#1194](https://github.com/GenericMappingTools/pygmt/pull/1194)) * Use colorblind-friendly colors in the scatter plots gallery example ([#1013](https://github.com/GenericMappingTools/pygmt/pull/1013)) -* [Fix]: warning in building the documentation ([#1178](https://github.com/GenericMappingTools/pygmt/pull/1178)) * Add a tutorial for plotting vectors ([#1070](https://github.com/GenericMappingTools/pygmt/pull/1070)) * Clarify interplay of spacing and per_column in info ([#1127](https://github.com/GenericMappingTools/pygmt/pull/1127)) * Update the check_figures_equal testing section in CONTRIBUTING.md ([#1108](https://github.com/GenericMappingTools/pygmt/pull/1108)) From 3a688374ceaafe8fb880c4c8ea9316f955ecd636 Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Sat, 19 Jun 2021 19:23:16 -0400 Subject: [PATCH 10/26] Draft some highlights --- doc/changes.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/doc/changes.md b/doc/changes.md index 48266176c32..01f69d9965e 100644 --- a/doc/changes.md +++ b/doc/changes.md @@ -5,7 +5,10 @@ ### Highlights -* +* 🎉 **Fourth minor release of PyGMT** 🎉 +* 10 new PyGMT functions and methods +* New and improved gallery examples and tutorials +* Drop GMT 6.1.1 support ### New Features From 2613ab5facd389a35b3fc166b740259193ff9db2 Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Sat, 19 Jun 2021 19:42:24 -0400 Subject: [PATCH 11/26] Format contributors section --- doc/changes.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/doc/changes.md b/doc/changes.md index 01f69d9965e..08da1d19b7c 100644 --- a/doc/changes.md +++ b/doc/changes.md @@ -110,7 +110,23 @@ ### Contributors -@Lawqup, @MichaeINeumann, @alperen-kilic, @core-man, @dependabot, @dependabot[bot], @eemcmullan, @itsabhianant, @lhoupert, @mdtanker, @meghanrjones, @michaelgrund, @noorbuchi, @seisman, @shahid-0, @vitorgt, @weiji14, @willschlitzer and @xdshivani +* [Dongdong Tian](https://github.com/seisman) +* [Wei Ji Leong](https://github.com/weiji14) +* [Michael Grund](https://github.com/michaelgrund) +* [Meghan Jones](https://github.com/meghanrjones) +* [Will Schlitzer](https://github.com/willschlitzer) +* [Jiayuan Yao](https://github.com/core-man) +* [Abhishek Anant](https://github.com/itsabhianant) +* [Michael Neumann](https://github.com/MichaeINeumann) +* [Noor Buchi](https://github.com/noorbuchi) +* [Shivani chauhan](https://github.com/xdshivani) +* [@alperen-kilic](https://github.com/alperen-kilic) +* [Loïc Houpert](https://github.com/lhoupert) +* @teriyakiSauce23 +* [Emily McMullan](https://github.com/eemcmullan) +* [@mdtanker](https://github.com/mdtanker) +* [@shahid-0](https://github.com/shahid-0) +* [Vitor Gratiere Torres](https://github.com/vitorgt) ---- From f458e6dd56a944b06f3281f4bd3b61376fd72f42 Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Sat, 19 Jun 2021 19:46:06 -0400 Subject: [PATCH 12/26] Remove CI configuration PR --- doc/changes.md | 1 - 1 file changed, 1 deletion(-) diff --git a/doc/changes.md b/doc/changes.md index 08da1d19b7c..8e1c0f4140a 100644 --- a/doc/changes.md +++ b/doc/changes.md @@ -91,7 +91,6 @@ ### Maintenance -* Reinstall optional geopandas dependency on CI tests ([#1331](https://github.com/GenericMappingTools/pygmt/pull/1331)) * Fix rose tests for GMT 6.2.0 ([#1324](https://github.com/GenericMappingTools/pygmt/pull/1324)) * Add a workflow to upload baseline images as a release asset ([#1317](https://github.com/GenericMappingTools/pygmt/pull/1317)) * Bump the minimum required GMT version to 6.2.0 ([#1321](https://github.com/GenericMappingTools/pygmt/pull/1321)) From ef3bc158b6394680604111ef5e6a9ea892011313 Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Sat, 19 Jun 2021 20:03:55 -0400 Subject: [PATCH 13/26] Add date --- doc/changes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/changes.md b/doc/changes.md index 8e1c0f4140a..dc0eb89e1f8 100644 --- a/doc/changes.md +++ b/doc/changes.md @@ -1,5 +1,5 @@ # Changelog -## Release v0.4.0 (20YY/MM/DD) +## Release v0.4.0 (2021/06/20) [![Digital Object Identifier for PyGMT v0.4.0](https://zenodo.org/badge/DOI/10.5281/zenodo.3781524.svg)](https://doi.org/10.5281/zenodo.4978645) From 08bbff0d16c29617e45378ae4f6fda2c5eb4c9e5 Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Sat, 19 Jun 2021 20:07:55 -0400 Subject: [PATCH 14/26] Fix typo --- doc/changes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/changes.md b/doc/changes.md index dc0eb89e1f8..806f83298a2 100644 --- a/doc/changes.md +++ b/doc/changes.md @@ -99,7 +99,7 @@ * Update fig.basemap, fig.subplot and fig.wiggle baseline images for GMT 6.2.0rc2 ([#1291](https://github.com/GenericMappingTools/pygmt/pull/1291)) * Remove xfails and workarounds for datetime inputs into pygmt.info ([#1236](https://github.com/GenericMappingTools/pygmt/pull/1236)) * Improve the DVC image diff workflow to support side-by-side comparison of modified images ([#1219](https://github.com/GenericMappingTools/pygmt/pull/1219)) -* Document the deprecation policy and addd the deprecate_parameter decorator to deprecate parameters ([#1160](https://github.com/GenericMappingTools/pygmt/pull/1160)) +* Document the deprecation policy and add the deprecate_parameter decorator to deprecate parameters ([#1160](https://github.com/GenericMappingTools/pygmt/pull/1160)) * Convert booleans arguments in build_arg_string, not in kwargs_to_strings ([#1125](https://github.com/GenericMappingTools/pygmt/pull/1125)) * Create Github Action workflow for reporting DVC image diffs ([#1104](https://github.com/GenericMappingTools/pygmt/pull/1104)) * Add new function to load fractures sample data ([#1101](https://github.com/GenericMappingTools/pygmt/pull/1101)) From d2b3ed6190f17a4b3f87dd2064b0a8d055764f9c Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Sat, 19 Jun 2021 22:03:18 -0400 Subject: [PATCH 15/26] Apply suggestions from code review Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com> Co-authored-by: Dongdong Tian --- doc/changes.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/doc/changes.md b/doc/changes.md index 806f83298a2..549c1b2aed6 100644 --- a/doc/changes.md +++ b/doc/changes.md @@ -1,7 +1,7 @@ # Changelog ## Release v0.4.0 (2021/06/20) -[![Digital Object Identifier for PyGMT v0.4.0](https://zenodo.org/badge/DOI/10.5281/zenodo.3781524.svg)](https://doi.org/10.5281/zenodo.4978645) +[![Digital Object Identifier for PyGMT v0.4.0](https://zenodo.org/badge/DOI/10.5281/zenodo.4978645.svg)](https://doi.org/10.5281/zenodo.4978645) ### Highlights @@ -58,7 +58,6 @@ * Let Figure.savefig support filenames with spaces ([#1116](https://github.com/GenericMappingTools/pygmt/pull/1116)) * Explicitly use netcdf4 engine in xarray.open_dataarray to read grd files ([#1264](https://github.com/GenericMappingTools/pygmt/pull/1264)) -* Fixed typo of "projecton" to "projection" in subplot module. ([#1214](https://github.com/GenericMappingTools/pygmt/pull/1214)) * Let Figure.show(method='external') work well in Python scripts ([#1062](https://github.com/GenericMappingTools/pygmt/pull/1062)) ### Documentation @@ -116,14 +115,17 @@ * [Will Schlitzer](https://github.com/willschlitzer) * [Jiayuan Yao](https://github.com/core-man) * [Abhishek Anant](https://github.com/itsabhianant) +* [Claire Klima](https://github.com/cklima616) +* [Megan Munzek](https://github.com/munzekm) * [Michael Neumann](https://github.com/MichaeINeumann) +* [Nathan Loria](https://github.com/Nathandloria) * [Noor Buchi](https://github.com/noorbuchi) * [Shivani chauhan](https://github.com/xdshivani) * [@alperen-kilic](https://github.com/alperen-kilic) * [Loïc Houpert](https://github.com/lhoupert) -* @teriyakiSauce23 * [Emily McMullan](https://github.com/eemcmullan) -* [@mdtanker](https://github.com/mdtanker) +* [Lawrence Qupty](https://github.com/Lawqup) +* [Matthew Tankersley](https://github.com/mdtanker) * [@shahid-0](https://github.com/shahid-0) * [Vitor Gratiere Torres](https://github.com/vitorgt) From d06e0d469ff2e06f6be129c13478d51bbe4b45e6 Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Sat, 19 Jun 2021 22:11:19 -0400 Subject: [PATCH 16/26] Add tab auto-completion to highlights Co-authored-by: Dongdong Tian --- doc/changes.md | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/changes.md b/doc/changes.md index 549c1b2aed6..9edc8864d7e 100644 --- a/doc/changes.md +++ b/doc/changes.md @@ -8,6 +8,7 @@ * 🎉 **Fourth minor release of PyGMT** 🎉 * 10 new PyGMT functions and methods * New and improved gallery examples and tutorials +* Support tab auto-completion in Jupyter * Drop GMT 6.1.1 support ### New Features From 430e7d96992d757c18234c077903611e7e0c8562 Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Sat, 19 Jun 2021 22:20:05 -0400 Subject: [PATCH 17/26] Sort new features, enhancements, deprecations, bug fixes, and documentation --- doc/changes.md | 41 +++++++++++++++++++++-------------------- 1 file changed, 21 insertions(+), 20 deletions(-) diff --git a/doc/changes.md b/doc/changes.md index 9edc8864d7e..128ac9adb83 100644 --- a/doc/changes.md +++ b/doc/changes.md @@ -13,53 +13,54 @@ ### New Features -* Wrap grdlandmask ([#1273](https://github.com/GenericMappingTools/pygmt/pull/1273)) -* Wrap grdgradient ([#1269](https://github.com/GenericMappingTools/pygmt/pull/1269)) -* Wrap grdfill ([#1276](https://github.com/GenericMappingTools/pygmt/pull/1276)) +* Wrap blockmean ([#1092](https://github.com/GenericMappingTools/pygmt/pull/1092)) * Wrap grdclip ([#1261](https://github.com/GenericMappingTools/pygmt/pull/1261)) -* Handle geopandas and shapely geometries via geo_interface link ([#1000](https://github.com/GenericMappingTools/pygmt/pull/1000)) -* Wrap velo ([#525](https://github.com/GenericMappingTools/pygmt/pull/525)) +* Wrap grdfill ([#1276](https://github.com/GenericMappingTools/pygmt/pull/1276)) +* Wrap grdgradient ([#1269](https://github.com/GenericMappingTools/pygmt/pull/1269)) +* Wrap grdlandmask ([#1273](https://github.com/GenericMappingTools/pygmt/pull/1273)) * Wrap histogram ([#1072](https://github.com/GenericMappingTools/pygmt/pull/1072)) -* Wrap wiggle ([#1145](https://github.com/GenericMappingTools/pygmt/pull/1145)) -* Support passing string type numbers, geographic coordinates and datetimes ([#975](https://github.com/GenericMappingTools/pygmt/pull/975)) * Wrap rose ([#794](https://github.com/GenericMappingTools/pygmt/pull/794)) * Wrap solar ([#804](https://github.com/GenericMappingTools/pygmt/pull/804)) -* Wrap blockmean ([#1092](https://github.com/GenericMappingTools/pygmt/pull/1092)) +* Wrap velo ([#525](https://github.com/GenericMappingTools/pygmt/pull/525)) +* Wrap wiggle ([#1145](https://github.com/GenericMappingTools/pygmt/pull/1145)) * Allow load_earth_relief() to load the original land-only 01s or 03s SRTM tiles ([#976](https://github.com/GenericMappingTools/pygmt/pull/976)) +* Handle geopandas and shapely geometries via geo_interface link ([#1000](https://github.com/GenericMappingTools/pygmt/pull/1000)) +* Support passing string type numbers, geographic coordinates and datetimes ([#975](https://github.com/GenericMappingTools/pygmt/pull/975)) + ### Enhancements -* Allow x/y/z input for blockmedian and blockmean ([#1319](https://github.com/GenericMappingTools/pygmt/pull/1319)) -* Support tab completion in Jupyter by inserting aliases into the method signature ([#1282](https://github.com/GenericMappingTools/pygmt/pull/1282)) +* Allow passing an array as intensity for plot3d ([#1109](https://github.com/GenericMappingTools/pygmt/pull/1109)) +* Allow passing an array as intensity for plot ([#1065](https://github.com/GenericMappingTools/pygmt/pull/1065)) * Allow passing xr.DataArray as shading to grdimage ([#750](https://github.com/GenericMappingTools/pygmt/pull/750)) +* Allow x/y/z input for blockmedian and blockmean ([#1319](https://github.com/GenericMappingTools/pygmt/pull/1319)) * Allow pygmt.which to accept a list of filenames as input ([#1312](https://github.com/GenericMappingTools/pygmt/pull/1312)) -* Let Figure.savefig recommend .eps or .pdf when .ps extension is used ([#1307](https://github.com/GenericMappingTools/pygmt/pull/1307)) -* Add incols to COMMON_OPTIONS, blockmean, and blockmedian ([#1300](https://github.com/GenericMappingTools/pygmt/pull/1300)) * Refactor blockm* to use virtualfile_from_data and improve i/o ([#1280](https://github.com/GenericMappingTools/pygmt/pull/1280)) -* Add parameters to histogram ([#1249](https://github.com/GenericMappingTools/pygmt/pull/1249)) * Refactor grdtrack to use virtualfile_from_data and improve i/o to pandas.DataFrame ([#1189](https://github.com/GenericMappingTools/pygmt/pull/1189)) +* Support tab completion in Jupyter by inserting aliases into the method signature ([#1282](https://github.com/GenericMappingTools/pygmt/pull/1282)) +* Let Figure.savefig recommend .eps or .pdf when .ps extension is used ([#1307](https://github.com/GenericMappingTools/pygmt/pull/1307)) * Improve Figure.show for displaying previews in Jupyter notebooks and external viewers ([#529](https://github.com/GenericMappingTools/pygmt/pull/529)) -* Allow passing an array as intensity for plot3d ([#1109](https://github.com/GenericMappingTools/pygmt/pull/1109)) -* Allow passing an array as intensity for plot ([#1065](https://github.com/GenericMappingTools/pygmt/pull/1065)) +* Add parameters to histogram ([#1249](https://github.com/GenericMappingTools/pygmt/pull/1249)) * Add alias 'aspatial' to methods blockmedian, info, plot, plot3d, surface ([#1090](https://github.com/GenericMappingTools/pygmt/pull/1090)) * Add alias 'registration' to methods blockmean, info, grdfilter, surface ([#1089](https://github.com/GenericMappingTools/pygmt/pull/1089)) +* Add incols to COMMON_OPTIONS, blockmean, and blockmedian ([#1300](https://github.com/GenericMappingTools/pygmt/pull/1300)) ### Deprecations -* Figure.plot3d: Deprecate parameter "columns" to "incols" (remove in v0.6.0) ([#1040](https://github.com/GenericMappingTools/pygmt/pull/1040)) -* Raise a warning for the use of short-form parameters when long-forms are available ([#1316](https://github.com/GenericMappingTools/pygmt/pull/1316)) * Figure.contour: Deprecate parameter "columns" to "incols" (remove in v0.6.0) ([#1303](https://github.com/GenericMappingTools/pygmt/pull/1303)) -* Figure.rose: Deprecate parameter "columns" to "incols" (remove in v0.6.0) ([#1306](https://github.com/GenericMappingTools/pygmt/pull/1306)) +* Figure.plot: Deprecate parameter "sizes" to "size" (remove in v0.6.0) ([#1254](https://github.com/GenericMappingTools/pygmt/pull/1254)) * Figure.plot: Deprecate parameter "columns" to "incols" (remove in v0.6.0) ([#1298](https://github.com/GenericMappingTools/pygmt/pull/1298)) * Figure.plot3d: Deprecate parameter "sizes" to "size" (remove in v0.6.0) ([#1258](https://github.com/GenericMappingTools/pygmt/pull/1258)) -* Figure.plot: Deprecate parameter "sizes" to "size" (remove in v0.6.0) ([#1254](https://github.com/GenericMappingTools/pygmt/pull/1254)) +* Figure.plot3d: Deprecate parameter "columns" to "incols" (remove in v0.6.0) ([#1040](https://github.com/GenericMappingTools/pygmt/pull/1040)) +* Figure.rose: Deprecate parameter "columns" to "incols" (remove in v0.6.0) ([#1306](https://github.com/GenericMappingTools/pygmt/pull/1306)) +* Raise a warning for the use of short-form parameters when long-forms are available ([#1316](https://github.com/GenericMappingTools/pygmt/pull/1316)) * NEP29: Set minimum required versions to NumPy 1.17+ and Python 3.7+ ([#1074](https://github.com/GenericMappingTools/pygmt/pull/1074)) ### Bug Fixes * Let Figure.savefig support filenames with spaces ([#1116](https://github.com/GenericMappingTools/pygmt/pull/1116)) -* Explicitly use netcdf4 engine in xarray.open_dataarray to read grd files ([#1264](https://github.com/GenericMappingTools/pygmt/pull/1264)) * Let Figure.show(method='external') work well in Python scripts ([#1062](https://github.com/GenericMappingTools/pygmt/pull/1062)) +* Explicitly use netcdf4 engine in xarray.open_dataarray to read grd files ([#1264](https://github.com/GenericMappingTools/pygmt/pull/1264)) ### Documentation From 3174e19882c685c91e332019c18384217c75c354 Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Sat, 19 Jun 2021 22:23:06 -0400 Subject: [PATCH 18/26] Remove PRs from maintainance section Co-authored-by: Wei Ji --- doc/changes.md | 30 ++++++++++++++---------------- 1 file changed, 14 insertions(+), 16 deletions(-) diff --git a/doc/changes.md b/doc/changes.md index 128ac9adb83..6316e57f595 100644 --- a/doc/changes.md +++ b/doc/changes.md @@ -65,39 +65,37 @@ ### Documentation * Specify rectangle's width and height via style parameter in multi-parameter symbols example ([#1325](https://github.com/GenericMappingTools/pygmt/pull/1325)) -* Move contributing guide details to website and rename two sections ([#1335](https://github.com/GenericMappingTools/pygmt/pull/1335)) +* Update the inset gallery example ([#1287](https://github.com/GenericMappingTools/pygmt/pull/1287)) +* Add histogram gallery example ([#1272](https://github.com/GenericMappingTools/pygmt/pull/1272)) +* Add a gallery example showing individual basic geometric symbols ([#1211](https://github.com/GenericMappingTools/pygmt/pull/1211)) +* Add categorical colorbars for plot, plot3d and line colors gallery examples ([#1267](https://github.com/GenericMappingTools/pygmt/pull/1267)) +* Apply NIST SI unit convention to some gallery examples ([#1194](https://github.com/GenericMappingTools/pygmt/pull/1194)) +* Use colorblind-friendly colors in the scatter plots gallery example ([#1013](https://github.com/GenericMappingTools/pygmt/pull/1013)) +* Added documentation for three oblique mercator projections ([#1251](https://github.com/GenericMappingTools/pygmt/pull/1251)) * Add a tutorial for datetime data ([#1193](https://github.com/GenericMappingTools/pygmt/pull/1193)) +* Add a tutorial for plotting vectors ([#1070](https://github.com/GenericMappingTools/pygmt/pull/1070)) +* Add a list of external PyGMT resources ([#1210](https://github.com/GenericMappingTools/pygmt/pull/1210)) * Complete documentation for grdtrack ([#1190](https://github.com/GenericMappingTools/pygmt/pull/1190)) -* Add guidelines for managing issues to maintenance.md ([#1301](https://github.com/GenericMappingTools/pygmt/pull/1301)) -* Update the inset gallery example ([#1287](https://github.com/GenericMappingTools/pygmt/pull/1287)) -* Clarify position of deprecate_parameter decorator to be above use_alias ([#1302](https://github.com/GenericMappingTools/pygmt/pull/1302)) * Add projection and region to grdview docstring ([#1295](https://github.com/GenericMappingTools/pygmt/pull/1295)) * Add common alias spacing (-I) for specifying grid increments ([#1288](https://github.com/GenericMappingTools/pygmt/pull/1288)) -* Revise Pull Request review process in CONTRIBUTING.md ([#1119](https://github.com/GenericMappingTools/pygmt/pull/1119)) -* Clarify that the "transparency" parameter in plot/plot3d/text can be 1d array ([#1265](https://github.com/GenericMappingTools/pygmt/pull/1265)) -* Add histogram gallery example ([#1272](https://github.com/GenericMappingTools/pygmt/pull/1272)) * Standardize docstrings for table-like inputs ([#1186](https://github.com/GenericMappingTools/pygmt/pull/1186)) -* Add categorical colorbars for plot, plot3d and line colors gallery examples ([#1267](https://github.com/GenericMappingTools/pygmt/pull/1267)) +* Clarify that the "transparency" parameter in plot/plot3d/text can be 1d array ([#1265](https://github.com/GenericMappingTools/pygmt/pull/1265)) * Clarify that the "color" parameter in plot/plot3d can be 1d array ([#1260](https://github.com/GenericMappingTools/pygmt/pull/1260)) -* Added documentation for three oblique mercator projections ([#1251](https://github.com/GenericMappingTools/pygmt/pull/1251)) * Add alias name convention to CONTRIBUTING.md ([#1256](https://github.com/GenericMappingTools/pygmt/pull/1256)) -* Add a list of external PyGMT resources ([#1210](https://github.com/GenericMappingTools/pygmt/pull/1210)) -* Add a gallery example showing individual basic geometric symbols ([#1211](https://github.com/GenericMappingTools/pygmt/pull/1211)) * Remove the "full test" section from installation guide ([#1206](https://github.com/GenericMappingTools/pygmt/pull/1206)) -* Apply NIST SI unit convention to some gallery examples ([#1194](https://github.com/GenericMappingTools/pygmt/pull/1194)) -* Use colorblind-friendly colors in the scatter plots gallery example ([#1013](https://github.com/GenericMappingTools/pygmt/pull/1013)) -* Add a tutorial for plotting vectors ([#1070](https://github.com/GenericMappingTools/pygmt/pull/1070)) * Clarify interplay of spacing and per_column in info ([#1127](https://github.com/GenericMappingTools/pygmt/pull/1127)) +* Clarify position of deprecate_parameter decorator to be above use_alias ([#1302](https://github.com/GenericMappingTools/pygmt/pull/1302)) +* Move contributing guide details to website and rename two sections ([#1335](https://github.com/GenericMappingTools/pygmt/pull/1335)) +* Add guidelines for managing issues to maintenance.md ([#1301](https://github.com/GenericMappingTools/pygmt/pull/1301)) * Update the check_figures_equal testing section in CONTRIBUTING.md ([#1108](https://github.com/GenericMappingTools/pygmt/pull/1108)) +* Revise Pull Request review process in CONTRIBUTING.md ([#1119](https://github.com/GenericMappingTools/pygmt/pull/1119)) ### Maintenance -* Fix rose tests for GMT 6.2.0 ([#1324](https://github.com/GenericMappingTools/pygmt/pull/1324)) * Add a workflow to upload baseline images as a release asset ([#1317](https://github.com/GenericMappingTools/pygmt/pull/1317)) * Bump the minimum required GMT version to 6.2.0 ([#1321](https://github.com/GenericMappingTools/pygmt/pull/1321)) * Add regression test for grdimage plotting an xarray.DataArray grid subset ([#1314](https://github.com/GenericMappingTools/pygmt/pull/1314)) * Add download_test_data to download data files used in tests ([#1310](https://github.com/GenericMappingTools/pygmt/pull/1310)) -* Update fig.basemap, fig.subplot and fig.wiggle baseline images for GMT 6.2.0rc2 ([#1291](https://github.com/GenericMappingTools/pygmt/pull/1291)) * Remove xfails and workarounds for datetime inputs into pygmt.info ([#1236](https://github.com/GenericMappingTools/pygmt/pull/1236)) * Improve the DVC image diff workflow to support side-by-side comparison of modified images ([#1219](https://github.com/GenericMappingTools/pygmt/pull/1219)) * Document the deprecation policy and add the deprecate_parameter decorator to deprecate parameters ([#1160](https://github.com/GenericMappingTools/pygmt/pull/1160)) From 5b961bbed7f55261df4a4f5dc82e0a72774ed3e4 Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Sat, 19 Jun 2021 22:24:52 -0400 Subject: [PATCH 19/26] Add PR #1329 --- doc/changes.md | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/changes.md b/doc/changes.md index 6316e57f595..dab1a882243 100644 --- a/doc/changes.md +++ b/doc/changes.md @@ -58,6 +58,7 @@ ### Bug Fixes +* Allow pandas.Series inputs to fig.histogram and pygmt.info ([#1329](https://github.com/GenericMappingTools/pygmt/pull/1329)) * Let Figure.savefig support filenames with spaces ([#1116](https://github.com/GenericMappingTools/pygmt/pull/1116)) * Let Figure.show(method='external') work well in Python scripts ([#1062](https://github.com/GenericMappingTools/pygmt/pull/1062)) * Explicitly use netcdf4 engine in xarray.open_dataarray to read grd files ([#1264](https://github.com/GenericMappingTools/pygmt/pull/1264)) From b2a824fe41483de80b27fbe60d2199e02ddb2b52 Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Sat, 19 Jun 2021 22:49:01 -0400 Subject: [PATCH 20/26] Update README.rst Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com> --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 9fc54181377..c22fc28bd01 100644 --- a/README.rst +++ b/README.rst @@ -236,7 +236,7 @@ Compatibility with GMT and Python/NumPy versions ======= ========== ========= ========= PyGMT GMT Python NumPy ======= ========== ========= ========= -0.4.0 >=6.2.0 >=3.7 >=1.17.0 +0.4.x >=6.2.0 >=3.7 >=1.17.0 0.3.x >=6.1.1 >=3.7 0.2.1 >=6.1.1 >=3.6 0.2.0 >=6.1.1 3.6 - 3.8 From 3d89ae7a18bc3311655d3e37b1e017a75afc5ede Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Sun, 20 Jun 2021 09:24:42 -0400 Subject: [PATCH 21/26] Apply suggestions from code review Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com> --- doc/changes.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/doc/changes.md b/doc/changes.md index dab1a882243..38d8060b48d 100644 --- a/doc/changes.md +++ b/doc/changes.md @@ -1,4 +1,5 @@ # Changelog + ## Release v0.4.0 (2021/06/20) [![Digital Object Identifier for PyGMT v0.4.0](https://zenodo.org/badge/DOI/10.5281/zenodo.4978645.svg)](https://doi.org/10.5281/zenodo.4978645) @@ -8,8 +9,8 @@ * 🎉 **Fourth minor release of PyGMT** 🎉 * 10 new PyGMT functions and methods * New and improved gallery examples and tutorials -* Support tab auto-completion in Jupyter -* Drop GMT 6.1.1 support +* Support tab auto-completion in Jupyter ([#1282](https://github.com/GenericMappingTools/pygmt/pull/1282)) +* Minimum required GMT version is now 6.2.0 or newer ([#1321](https://github.com/GenericMappingTools/pygmt/pull/1321)) ### New Features @@ -27,7 +28,6 @@ * Handle geopandas and shapely geometries via geo_interface link ([#1000](https://github.com/GenericMappingTools/pygmt/pull/1000)) * Support passing string type numbers, geographic coordinates and datetimes ([#975](https://github.com/GenericMappingTools/pygmt/pull/975)) - ### Enhancements * Allow passing an array as intensity for plot3d ([#1109](https://github.com/GenericMappingTools/pygmt/pull/1109)) @@ -37,7 +37,6 @@ * Allow pygmt.which to accept a list of filenames as input ([#1312](https://github.com/GenericMappingTools/pygmt/pull/1312)) * Refactor blockm* to use virtualfile_from_data and improve i/o ([#1280](https://github.com/GenericMappingTools/pygmt/pull/1280)) * Refactor grdtrack to use virtualfile_from_data and improve i/o to pandas.DataFrame ([#1189](https://github.com/GenericMappingTools/pygmt/pull/1189)) -* Support tab completion in Jupyter by inserting aliases into the method signature ([#1282](https://github.com/GenericMappingTools/pygmt/pull/1282)) * Let Figure.savefig recommend .eps or .pdf when .ps extension is used ([#1307](https://github.com/GenericMappingTools/pygmt/pull/1307)) * Improve Figure.show for displaying previews in Jupyter notebooks and external viewers ([#529](https://github.com/GenericMappingTools/pygmt/pull/529)) * Add parameters to histogram ([#1249](https://github.com/GenericMappingTools/pygmt/pull/1249)) @@ -94,7 +93,6 @@ ### Maintenance * Add a workflow to upload baseline images as a release asset ([#1317](https://github.com/GenericMappingTools/pygmt/pull/1317)) -* Bump the minimum required GMT version to 6.2.0 ([#1321](https://github.com/GenericMappingTools/pygmt/pull/1321)) * Add regression test for grdimage plotting an xarray.DataArray grid subset ([#1314](https://github.com/GenericMappingTools/pygmt/pull/1314)) * Add download_test_data to download data files used in tests ([#1310](https://github.com/GenericMappingTools/pygmt/pull/1310)) * Remove xfails and workarounds for datetime inputs into pygmt.info ([#1236](https://github.com/GenericMappingTools/pygmt/pull/1236)) From 3cdceb364d707c16bb4db23dc7adfd0abc164857 Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Sun, 20 Jun 2021 09:29:45 -0400 Subject: [PATCH 22/26] Update highlights --- doc/changes.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/doc/changes.md b/doc/changes.md index 38d8060b48d..8cb2354fda4 100644 --- a/doc/changes.md +++ b/doc/changes.md @@ -7,8 +7,8 @@ ### Highlights * 🎉 **Fourth minor release of PyGMT** 🎉 -* 10 new PyGMT functions and methods -* New and improved gallery examples and tutorials +* Add a tutorial for datetime data ([#1193](https://github.com/GenericMappingTools/pygmt/pull/1193)) +* Add a tutorial for plotting vectors ([#1070](https://github.com/GenericMappingTools/pygmt/pull/1070)) * Support tab auto-completion in Jupyter ([#1282](https://github.com/GenericMappingTools/pygmt/pull/1282)) * Minimum required GMT version is now 6.2.0 or newer ([#1321](https://github.com/GenericMappingTools/pygmt/pull/1321)) @@ -72,8 +72,6 @@ * Apply NIST SI unit convention to some gallery examples ([#1194](https://github.com/GenericMappingTools/pygmt/pull/1194)) * Use colorblind-friendly colors in the scatter plots gallery example ([#1013](https://github.com/GenericMappingTools/pygmt/pull/1013)) * Added documentation for three oblique mercator projections ([#1251](https://github.com/GenericMappingTools/pygmt/pull/1251)) -* Add a tutorial for datetime data ([#1193](https://github.com/GenericMappingTools/pygmt/pull/1193)) -* Add a tutorial for plotting vectors ([#1070](https://github.com/GenericMappingTools/pygmt/pull/1070)) * Add a list of external PyGMT resources ([#1210](https://github.com/GenericMappingTools/pygmt/pull/1210)) * Complete documentation for grdtrack ([#1190](https://github.com/GenericMappingTools/pygmt/pull/1190)) * Add projection and region to grdview docstring ([#1295](https://github.com/GenericMappingTools/pygmt/pull/1295)) From ef595411f63ae1f3f57075a0fe3f75156035ea86 Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Sun, 20 Jun 2021 10:02:21 -0400 Subject: [PATCH 23/26] Apply suggestions from code review Co-authored-by: Yao Jiayuan --- doc/changes.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/doc/changes.md b/doc/changes.md index 8cb2354fda4..a73754d6979 100644 --- a/doc/changes.md +++ b/doc/changes.md @@ -37,12 +37,12 @@ * Allow pygmt.which to accept a list of filenames as input ([#1312](https://github.com/GenericMappingTools/pygmt/pull/1312)) * Refactor blockm* to use virtualfile_from_data and improve i/o ([#1280](https://github.com/GenericMappingTools/pygmt/pull/1280)) * Refactor grdtrack to use virtualfile_from_data and improve i/o to pandas.DataFrame ([#1189](https://github.com/GenericMappingTools/pygmt/pull/1189)) -* Let Figure.savefig recommend .eps or .pdf when .ps extension is used ([#1307](https://github.com/GenericMappingTools/pygmt/pull/1307)) -* Improve Figure.show for displaying previews in Jupyter notebooks and external viewers ([#529](https://github.com/GenericMappingTools/pygmt/pull/529)) * Add parameters to histogram ([#1249](https://github.com/GenericMappingTools/pygmt/pull/1249)) * Add alias 'aspatial' to methods blockmedian, info, plot, plot3d, surface ([#1090](https://github.com/GenericMappingTools/pygmt/pull/1090)) * Add alias 'registration' to methods blockmean, info, grdfilter, surface ([#1089](https://github.com/GenericMappingTools/pygmt/pull/1089)) * Add incols to COMMON_OPTIONS, blockmean, and blockmedian ([#1300](https://github.com/GenericMappingTools/pygmt/pull/1300)) +* Improve Figure.show for displaying previews in Jupyter notebooks and external viewers ([#529](https://github.com/GenericMappingTools/pygmt/pull/529)) +* Let Figure.savefig recommend .eps or .pdf when .ps extension is used ([#1307](https://github.com/GenericMappingTools/pygmt/pull/1307)) ### Deprecations @@ -52,22 +52,22 @@ * Figure.plot3d: Deprecate parameter "sizes" to "size" (remove in v0.6.0) ([#1258](https://github.com/GenericMappingTools/pygmt/pull/1258)) * Figure.plot3d: Deprecate parameter "columns" to "incols" (remove in v0.6.0) ([#1040](https://github.com/GenericMappingTools/pygmt/pull/1040)) * Figure.rose: Deprecate parameter "columns" to "incols" (remove in v0.6.0) ([#1306](https://github.com/GenericMappingTools/pygmt/pull/1306)) -* Raise a warning for the use of short-form parameters when long-forms are available ([#1316](https://github.com/GenericMappingTools/pygmt/pull/1316)) * NEP29: Set minimum required versions to NumPy 1.17+ and Python 3.7+ ([#1074](https://github.com/GenericMappingTools/pygmt/pull/1074)) +* Raise a warning for the use of short-form parameters when long-forms are available ([#1316](https://github.com/GenericMappingTools/pygmt/pull/1316)) ### Bug Fixes * Allow pandas.Series inputs to fig.histogram and pygmt.info ([#1329](https://github.com/GenericMappingTools/pygmt/pull/1329)) +* Explicitly use netcdf4 engine in xarray.open_dataarray to read grd files ([#1264](https://github.com/GenericMappingTools/pygmt/pull/1264)) * Let Figure.savefig support filenames with spaces ([#1116](https://github.com/GenericMappingTools/pygmt/pull/1116)) * Let Figure.show(method='external') work well in Python scripts ([#1062](https://github.com/GenericMappingTools/pygmt/pull/1062)) -* Explicitly use netcdf4 engine in xarray.open_dataarray to read grd files ([#1264](https://github.com/GenericMappingTools/pygmt/pull/1264)) ### Documentation -* Specify rectangle's width and height via style parameter in multi-parameter symbols example ([#1325](https://github.com/GenericMappingTools/pygmt/pull/1325)) -* Update the inset gallery example ([#1287](https://github.com/GenericMappingTools/pygmt/pull/1287)) * Add histogram gallery example ([#1272](https://github.com/GenericMappingTools/pygmt/pull/1272)) * Add a gallery example showing individual basic geometric symbols ([#1211](https://github.com/GenericMappingTools/pygmt/pull/1211)) +* Specify rectangle's width and height via style parameter in multi-parameter symbols example ([#1325](https://github.com/GenericMappingTools/pygmt/pull/1325)) +* Update the inset gallery example ([#1287](https://github.com/GenericMappingTools/pygmt/pull/1287)) * Add categorical colorbars for plot, plot3d and line colors gallery examples ([#1267](https://github.com/GenericMappingTools/pygmt/pull/1267)) * Apply NIST SI unit convention to some gallery examples ([#1194](https://github.com/GenericMappingTools/pygmt/pull/1194)) * Use colorblind-friendly colors in the scatter plots gallery example ([#1013](https://github.com/GenericMappingTools/pygmt/pull/1013)) @@ -79,12 +79,12 @@ * Standardize docstrings for table-like inputs ([#1186](https://github.com/GenericMappingTools/pygmt/pull/1186)) * Clarify that the "transparency" parameter in plot/plot3d/text can be 1d array ([#1265](https://github.com/GenericMappingTools/pygmt/pull/1265)) * Clarify that the "color" parameter in plot/plot3d can be 1d array ([#1260](https://github.com/GenericMappingTools/pygmt/pull/1260)) -* Add alias name convention to CONTRIBUTING.md ([#1256](https://github.com/GenericMappingTools/pygmt/pull/1256)) -* Remove the "full test" section from installation guide ([#1206](https://github.com/GenericMappingTools/pygmt/pull/1206)) * Clarify interplay of spacing and per_column in info ([#1127](https://github.com/GenericMappingTools/pygmt/pull/1127)) +* Remove the "full test" section from installation guide ([#1206](https://github.com/GenericMappingTools/pygmt/pull/1206)) * Clarify position of deprecate_parameter decorator to be above use_alias ([#1302](https://github.com/GenericMappingTools/pygmt/pull/1302)) -* Move contributing guide details to website and rename two sections ([#1335](https://github.com/GenericMappingTools/pygmt/pull/1335)) * Add guidelines for managing issues to maintenance.md ([#1301](https://github.com/GenericMappingTools/pygmt/pull/1301)) +* Add alias name convention to CONTRIBUTING.md ([#1256](https://github.com/GenericMappingTools/pygmt/pull/1256)) +* Move contributing guide details to website and rename two sections ([#1335](https://github.com/GenericMappingTools/pygmt/pull/1335)) * Update the check_figures_equal testing section in CONTRIBUTING.md ([#1108](https://github.com/GenericMappingTools/pygmt/pull/1108)) * Revise Pull Request review process in CONTRIBUTING.md ([#1119](https://github.com/GenericMappingTools/pygmt/pull/1119)) From c2c210df1eed9f84249ffb10b56efc4dde670f72 Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Sun, 20 Jun 2021 10:55:28 -0400 Subject: [PATCH 24/26] Update author list based on git shortlog + other factors --- README.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index c22fc28bd01..cf34b00b0e2 100644 --- a/README.rst +++ b/README.rst @@ -158,13 +158,14 @@ Developers". Feel free to cite our work in your research using the following Bib author = {Uieda, Leonardo and Tian, Dongdong and Leong, Wei Ji and - Toney, Liam and Schlitzer, William and - Yao, Jiayuan and + Toney, Liam and Grund, Michael and Jones, Meghan and + Yao, Jiayuan and Materna, Kathryn and Newton, Tyler and + Anant, Abhishek and Ziebarth, Malte and Wessel, Paul}, title = {{PyGMT: A Python interface for the Generic Mapping Tools}}, From e676b5affb09da99faf41b9d7319caf3ad168cf8 Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Sun, 20 Jun 2021 11:00:00 -0400 Subject: [PATCH 25/26] Condense tutorials highlights to one line --- doc/changes.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/doc/changes.md b/doc/changes.md index a73754d6979..c3415df4c5f 100644 --- a/doc/changes.md +++ b/doc/changes.md @@ -7,8 +7,7 @@ ### Highlights * 🎉 **Fourth minor release of PyGMT** 🎉 -* Add a tutorial for datetime data ([#1193](https://github.com/GenericMappingTools/pygmt/pull/1193)) -* Add a tutorial for plotting vectors ([#1070](https://github.com/GenericMappingTools/pygmt/pull/1070)) +* Add tutorials for datetime data ([#1193](https://github.com/GenericMappingTools/pygmt/pull/1193)) and plotting vectors ([#1070](https://github.com/GenericMappingTools/pygmt/pull/1070)) * Support tab auto-completion in Jupyter ([#1282](https://github.com/GenericMappingTools/pygmt/pull/1282)) * Minimum required GMT version is now 6.2.0 or newer ([#1321](https://github.com/GenericMappingTools/pygmt/pull/1321)) From 4fc6ab1a18d82fb65b7f9b1b647c3b0d87b549b5 Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Sun, 20 Jun 2021 17:43:21 -0400 Subject: [PATCH 26/26] Move load fractures function to features --- doc/changes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/changes.md b/doc/changes.md index c3415df4c5f..e3ff6af02a9 100644 --- a/doc/changes.md +++ b/doc/changes.md @@ -23,6 +23,7 @@ * Wrap solar ([#804](https://github.com/GenericMappingTools/pygmt/pull/804)) * Wrap velo ([#525](https://github.com/GenericMappingTools/pygmt/pull/525)) * Wrap wiggle ([#1145](https://github.com/GenericMappingTools/pygmt/pull/1145)) +* Add new function to load fractures sample data ([#1101](https://github.com/GenericMappingTools/pygmt/pull/1101)) * Allow load_earth_relief() to load the original land-only 01s or 03s SRTM tiles ([#976](https://github.com/GenericMappingTools/pygmt/pull/976)) * Handle geopandas and shapely geometries via geo_interface link ([#1000](https://github.com/GenericMappingTools/pygmt/pull/1000)) * Support passing string type numbers, geographic coordinates and datetimes ([#975](https://github.com/GenericMappingTools/pygmt/pull/975)) @@ -97,7 +98,6 @@ * Document the deprecation policy and add the deprecate_parameter decorator to deprecate parameters ([#1160](https://github.com/GenericMappingTools/pygmt/pull/1160)) * Convert booleans arguments in build_arg_string, not in kwargs_to_strings ([#1125](https://github.com/GenericMappingTools/pygmt/pull/1125)) * Create Github Action workflow for reporting DVC image diffs ([#1104](https://github.com/GenericMappingTools/pygmt/pull/1104)) -* Add new function to load fractures sample data ([#1101](https://github.com/GenericMappingTools/pygmt/pull/1101)) * Update "GMT Dev Tests" workflow to test macOS-11.0 and pre-release Python packages ([#1105](https://github.com/GenericMappingTools/pygmt/pull/1105)) * Initialize data version control for managing test images ([#1036](https://github.com/GenericMappingTools/pygmt/pull/1036)) * Separate workflows for running tests and building documentation ([#1033](https://github.com/GenericMappingTools/pygmt/pull/1033))