Skip to content

Commit b2808cf

Browse files
Meghan Jonesweiji14seismancore-man
authored
Changelog entry for v0.4.0 (#1341)
* Add changelog entry to changes.md * Update release highlights * Reorganize contributor list * Update citation * Update version_switch.js * Update documentation link Co-authored-by: Wei Ji <[email protected]> Co-authored-by: Dongdong Tian <[email protected]> Co-authored-by: Yao Jiayuan <[email protected]>
1 parent d9df659 commit b2808cf

File tree

3 files changed

+137
-7
lines changed

3 files changed

+137
-7
lines changed

README.rst

+9-7
Original file line numberDiff line numberDiff line change
@@ -154,26 +154,27 @@ Developers". Feel free to cite our work in your research using the following Bib
154154

155155
.. code-block::
156156
157-
@software{pygmt_2021_4592991,
157+
@software{pygmt_2021_4978645,
158158
author = {Uieda, Leonardo and
159159
Tian, Dongdong and
160160
Leong, Wei Ji and
161-
Toney, Liam and
162161
Schlitzer, William and
163-
Yao, Jiayuan and
162+
Toney, Liam and
164163
Grund, Michael and
165164
Jones, Meghan and
165+
Yao, Jiayuan and
166166
Materna, Kathryn and
167167
Newton, Tyler and
168+
Anant, Abhishek and
168169
Ziebarth, Malte and
169170
Wessel, Paul},
170171
title = {{PyGMT: A Python interface for the Generic Mapping Tools}},
171-
month = mar,
172+
month = jun,
172173
year = 2021,
173174
publisher = {Zenodo},
174-
version = {v0.3.1},
175-
doi = {10.5281/zenodo.4592991},
176-
url = {https://doi.org/10.5281/zenodo.4592991}
175+
version = {v0.4.0},
176+
doi = {10.5281/zenodo.4978645},
177+
url = {https://doi.org/10.5281/zenodo.4978645}
177178
}
178179
179180
To cite a specific version of PyGMT, go to our Zenodo page at
@@ -220,6 +221,7 @@ Documentation for other versions
220221
* `Development <https://www.pygmt.org/dev>`__ (reflects the *master* branch on
221222
GitHub)
222223
* `Latest release <https://www.pygmt.org/latest>`__
224+
* `v0.4.0 <https://www.pygmt.org/v0.4.0>`__
223225
* `v0.3.1 <https://www.pygmt.org/v0.3.1>`__
224226
* `v0.3.0 <https://www.pygmt.org/v0.3.0>`__
225227
* `v0.2.1 <https://www.pygmt.org/v0.2.1>`__

doc/_static/version_switch.js

+1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
var all_versions = {
1313
'latest': 'latest',
1414
'dev': 'dev',
15+
'v0.4.0': 'v0.4.0',
1516
'v0.3.1': 'v0.3.1',
1617
'v0.3.0': 'v0.3.0',
1718
'v0.2.1': 'v0.2.1',

doc/changes.md

+127
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,132 @@
11
# Changelog
22

3+
## Release v0.4.0 (2021/06/20)
4+
5+
[![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)
6+
7+
### Highlights
8+
9+
* 🎉 **Fourth minor release of PyGMT** 🎉
10+
* Add tutorials for datetime data ([#1193](https://github.com/GenericMappingTools/pygmt/pull/1193)) and plotting vectors ([#1070](https://github.com/GenericMappingTools/pygmt/pull/1070))
11+
* Support tab auto-completion in Jupyter ([#1282](https://github.com/GenericMappingTools/pygmt/pull/1282))
12+
* Minimum required GMT version is now 6.2.0 or newer ([#1321](https://github.com/GenericMappingTools/pygmt/pull/1321))
13+
14+
### New Features
15+
16+
* Wrap blockmean ([#1092](https://github.com/GenericMappingTools/pygmt/pull/1092))
17+
* Wrap grdclip ([#1261](https://github.com/GenericMappingTools/pygmt/pull/1261))
18+
* Wrap grdfill ([#1276](https://github.com/GenericMappingTools/pygmt/pull/1276))
19+
* Wrap grdgradient ([#1269](https://github.com/GenericMappingTools/pygmt/pull/1269))
20+
* Wrap grdlandmask ([#1273](https://github.com/GenericMappingTools/pygmt/pull/1273))
21+
* Wrap histogram ([#1072](https://github.com/GenericMappingTools/pygmt/pull/1072))
22+
* Wrap rose ([#794](https://github.com/GenericMappingTools/pygmt/pull/794))
23+
* Wrap solar ([#804](https://github.com/GenericMappingTools/pygmt/pull/804))
24+
* Wrap velo ([#525](https://github.com/GenericMappingTools/pygmt/pull/525))
25+
* Wrap wiggle ([#1145](https://github.com/GenericMappingTools/pygmt/pull/1145))
26+
* Add new function to load fractures sample data ([#1101](https://github.com/GenericMappingTools/pygmt/pull/1101))
27+
* Allow load_earth_relief() to load the original land-only 01s or 03s SRTM tiles ([#976](https://github.com/GenericMappingTools/pygmt/pull/976))
28+
* Handle geopandas and shapely geometries via geo_interface link ([#1000](https://github.com/GenericMappingTools/pygmt/pull/1000))
29+
* Support passing string type numbers, geographic coordinates and datetimes ([#975](https://github.com/GenericMappingTools/pygmt/pull/975))
30+
31+
### Enhancements
32+
33+
* Allow passing an array as intensity for plot3d ([#1109](https://github.com/GenericMappingTools/pygmt/pull/1109))
34+
* Allow passing an array as intensity for plot ([#1065](https://github.com/GenericMappingTools/pygmt/pull/1065))
35+
* Allow passing xr.DataArray as shading to grdimage ([#750](https://github.com/GenericMappingTools/pygmt/pull/750))
36+
* Allow x/y/z input for blockmedian and blockmean ([#1319](https://github.com/GenericMappingTools/pygmt/pull/1319))
37+
* Allow pygmt.which to accept a list of filenames as input ([#1312](https://github.com/GenericMappingTools/pygmt/pull/1312))
38+
* Refactor blockm* to use virtualfile_from_data and improve i/o ([#1280](https://github.com/GenericMappingTools/pygmt/pull/1280))
39+
* Refactor grdtrack to use virtualfile_from_data and improve i/o to pandas.DataFrame ([#1189](https://github.com/GenericMappingTools/pygmt/pull/1189))
40+
* Add parameters to histogram ([#1249](https://github.com/GenericMappingTools/pygmt/pull/1249))
41+
* Add alias 'aspatial' to methods blockmedian, info, plot, plot3d, surface ([#1090](https://github.com/GenericMappingTools/pygmt/pull/1090))
42+
* Add alias 'registration' to methods blockmean, info, grdfilter, surface ([#1089](https://github.com/GenericMappingTools/pygmt/pull/1089))
43+
* Add incols to COMMON_OPTIONS, blockmean, and blockmedian ([#1300](https://github.com/GenericMappingTools/pygmt/pull/1300))
44+
* Improve Figure.show for displaying previews in Jupyter notebooks and external viewers ([#529](https://github.com/GenericMappingTools/pygmt/pull/529))
45+
* Let Figure.savefig recommend .eps or .pdf when .ps extension is used ([#1307](https://github.com/GenericMappingTools/pygmt/pull/1307))
46+
47+
### Deprecations
48+
49+
* Figure.contour: Deprecate parameter "columns" to "incols" (remove in v0.6.0) ([#1303](https://github.com/GenericMappingTools/pygmt/pull/1303))
50+
* Figure.plot: Deprecate parameter "sizes" to "size" (remove in v0.6.0) ([#1254](https://github.com/GenericMappingTools/pygmt/pull/1254))
51+
* Figure.plot: Deprecate parameter "columns" to "incols" (remove in v0.6.0) ([#1298](https://github.com/GenericMappingTools/pygmt/pull/1298))
52+
* Figure.plot3d: Deprecate parameter "sizes" to "size" (remove in v0.6.0) ([#1258](https://github.com/GenericMappingTools/pygmt/pull/1258))
53+
* Figure.plot3d: Deprecate parameter "columns" to "incols" (remove in v0.6.0) ([#1040](https://github.com/GenericMappingTools/pygmt/pull/1040))
54+
* Figure.rose: Deprecate parameter "columns" to "incols" (remove in v0.6.0) ([#1306](https://github.com/GenericMappingTools/pygmt/pull/1306))
55+
* NEP29: Set minimum required versions to NumPy 1.17+ and Python 3.7+ ([#1074](https://github.com/GenericMappingTools/pygmt/pull/1074))
56+
* Raise a warning for the use of short-form parameters when long-forms are available ([#1316](https://github.com/GenericMappingTools/pygmt/pull/1316))
57+
58+
### Bug Fixes
59+
60+
* Allow pandas.Series inputs to fig.histogram and pygmt.info ([#1329](https://github.com/GenericMappingTools/pygmt/pull/1329))
61+
* Explicitly use netcdf4 engine in xarray.open_dataarray to read grd files ([#1264](https://github.com/GenericMappingTools/pygmt/pull/1264))
62+
* Let Figure.savefig support filenames with spaces ([#1116](https://github.com/GenericMappingTools/pygmt/pull/1116))
63+
* Let Figure.show(method='external') work well in Python scripts ([#1062](https://github.com/GenericMappingTools/pygmt/pull/1062))
64+
65+
### Documentation
66+
67+
* Add histogram gallery example ([#1272](https://github.com/GenericMappingTools/pygmt/pull/1272))
68+
* Add a gallery example showing individual basic geometric symbols ([#1211](https://github.com/GenericMappingTools/pygmt/pull/1211))
69+
* Specify rectangle's width and height via style parameter in multi-parameter symbols example ([#1325](https://github.com/GenericMappingTools/pygmt/pull/1325))
70+
* Update the inset gallery example ([#1287](https://github.com/GenericMappingTools/pygmt/pull/1287))
71+
* Add categorical colorbars for plot, plot3d and line colors gallery examples ([#1267](https://github.com/GenericMappingTools/pygmt/pull/1267))
72+
* Apply NIST SI unit convention to some gallery examples ([#1194](https://github.com/GenericMappingTools/pygmt/pull/1194))
73+
* Use colorblind-friendly colors in the scatter plots gallery example ([#1013](https://github.com/GenericMappingTools/pygmt/pull/1013))
74+
* Added documentation for three oblique mercator projections ([#1251](https://github.com/GenericMappingTools/pygmt/pull/1251))
75+
* Add a list of external PyGMT resources ([#1210](https://github.com/GenericMappingTools/pygmt/pull/1210))
76+
* Complete documentation for grdtrack ([#1190](https://github.com/GenericMappingTools/pygmt/pull/1190))
77+
* Add projection and region to grdview docstring ([#1295](https://github.com/GenericMappingTools/pygmt/pull/1295))
78+
* Add common alias spacing (-I) for specifying grid increments ([#1288](https://github.com/GenericMappingTools/pygmt/pull/1288))
79+
* Standardize docstrings for table-like inputs ([#1186](https://github.com/GenericMappingTools/pygmt/pull/1186))
80+
* Clarify that the "transparency" parameter in plot/plot3d/text can be 1d array ([#1265](https://github.com/GenericMappingTools/pygmt/pull/1265))
81+
* Clarify that the "color" parameter in plot/plot3d can be 1d array ([#1260](https://github.com/GenericMappingTools/pygmt/pull/1260))
82+
* Clarify interplay of spacing and per_column in info ([#1127](https://github.com/GenericMappingTools/pygmt/pull/1127))
83+
* Remove the "full test" section from installation guide ([#1206](https://github.com/GenericMappingTools/pygmt/pull/1206))
84+
* Clarify position of deprecate_parameter decorator to be above use_alias ([#1302](https://github.com/GenericMappingTools/pygmt/pull/1302))
85+
* Add guidelines for managing issues to maintenance.md ([#1301](https://github.com/GenericMappingTools/pygmt/pull/1301))
86+
* Add alias name convention to CONTRIBUTING.md ([#1256](https://github.com/GenericMappingTools/pygmt/pull/1256))
87+
* Move contributing guide details to website and rename two sections ([#1335](https://github.com/GenericMappingTools/pygmt/pull/1335))
88+
* Update the check_figures_equal testing section in CONTRIBUTING.md ([#1108](https://github.com/GenericMappingTools/pygmt/pull/1108))
89+
* Revise Pull Request review process in CONTRIBUTING.md ([#1119](https://github.com/GenericMappingTools/pygmt/pull/1119))
90+
91+
### Maintenance
92+
93+
* Add a workflow to upload baseline images as a release asset ([#1317](https://github.com/GenericMappingTools/pygmt/pull/1317))
94+
* Add regression test for grdimage plotting an xarray.DataArray grid subset ([#1314](https://github.com/GenericMappingTools/pygmt/pull/1314))
95+
* Add download_test_data to download data files used in tests ([#1310](https://github.com/GenericMappingTools/pygmt/pull/1310))
96+
* Remove xfails and workarounds for datetime inputs into pygmt.info ([#1236](https://github.com/GenericMappingTools/pygmt/pull/1236))
97+
* Improve the DVC image diff workflow to support side-by-side comparison of modified images ([#1219](https://github.com/GenericMappingTools/pygmt/pull/1219))
98+
* Document the deprecation policy and add the deprecate_parameter decorator to deprecate parameters ([#1160](https://github.com/GenericMappingTools/pygmt/pull/1160))
99+
* Convert booleans arguments in build_arg_string, not in kwargs_to_strings ([#1125](https://github.com/GenericMappingTools/pygmt/pull/1125))
100+
* Create Github Action workflow for reporting DVC image diffs ([#1104](https://github.com/GenericMappingTools/pygmt/pull/1104))
101+
* Update "GMT Dev Tests" workflow to test macOS-11.0 and pre-release Python packages ([#1105](https://github.com/GenericMappingTools/pygmt/pull/1105))
102+
* Initialize data version control for managing test images ([#1036](https://github.com/GenericMappingTools/pygmt/pull/1036))
103+
* Separate workflows for running tests and building documentation ([#1033](https://github.com/GenericMappingTools/pygmt/pull/1033))
104+
105+
### Contributors
106+
107+
* [Dongdong Tian](https://github.com/seisman)
108+
* [Wei Ji Leong](https://github.com/weiji14)
109+
* [Michael Grund](https://github.com/michaelgrund)
110+
* [Meghan Jones](https://github.com/meghanrjones)
111+
* [Will Schlitzer](https://github.com/willschlitzer)
112+
* [Jiayuan Yao](https://github.com/core-man)
113+
* [Abhishek Anant](https://github.com/itsabhianant)
114+
* [Claire Klima](https://github.com/cklima616)
115+
* [Megan Munzek](https://github.com/munzekm)
116+
* [Michael Neumann](https://github.com/MichaeINeumann)
117+
* [Nathan Loria](https://github.com/Nathandloria)
118+
* [Noor Buchi](https://github.com/noorbuchi)
119+
* [Shivani chauhan](https://github.com/xdshivani)
120+
* [@alperen-kilic](https://github.com/alperen-kilic)
121+
* [Loïc Houpert](https://github.com/lhoupert)
122+
* [Emily McMullan](https://github.com/eemcmullan)
123+
* [Lawrence Qupty](https://github.com/Lawqup)
124+
* [Matthew Tankersley](https://github.com/mdtanker)
125+
* [@shahid-0](https://github.com/shahid-0)
126+
* [Vitor Gratiere Torres](https://github.com/vitorgt)
127+
128+
----
129+
3130
## Release v0.3.1 (2021/03/14)
4131

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

0 commit comments

Comments
 (0)