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.5.0 #1594

Merged
merged 23 commits into from
Oct 29, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
ad5736c
initial copy for v0.5.0 changelog
willschlitzer Oct 29, 2021
ef9c0ab
remove README update
willschlitzer Oct 29, 2021
7c38c0c
update wording in maintenance changes
willschlitzer Oct 29, 2021
5008840
change order and organization of items in change log
willschlitzer Oct 29, 2021
f82677b
update author list
willschlitzer Oct 29, 2021
9253c96
add highlight
willschlitzer Oct 29, 2021
7e3c372
update README.rst; no changes to author list
willschlitzer Oct 29, 2021
8e6aa9f
add v0.5.0 to version_switch.js
willschlitzer Oct 29, 2021
3c24d75
adding version v0.5.0 as the latest release instead of dev release
willschlitzer Oct 29, 2021
0e54ddb
add dev release to PyGMT version table
willschlitzer Oct 29, 2021
d18ed2f
add wrapping 12 modules to highlights
willschlitzer Oct 29, 2021
3fc66f8
Merge branch 'main' into release/v0.5.0
willschlitzer Oct 29, 2021
009944d
Apply suggestions from code review
willschlitzer Oct 29, 2021
eddf8ad
move Yohai up in author list
willschlitzer Oct 29, 2021
dd46dc9
move Meghan up in author list
willschlitzer Oct 29, 2021
f20843f
Merge branch 'main' into release/v0.5.0
willschlitzer Oct 29, 2021
1e03470
remove highlight of Python 3.10 support
willschlitzer Oct 29, 2021
bbbc0ac
update CITATION.cff
willschlitzer Oct 29, 2021
1067dda
Apply suggestions from code review
willschlitzer Oct 29, 2021
6e2aa0a
Apply suggestions from code review
willschlitzer Oct 29, 2021
2787554
Apply suggestions from code review
willschlitzer Oct 29, 2021
7b83134
Merge branch 'main' into release/v0.5.0
willschlitzer Oct 29, 2021
4b7da9a
Update doc/changes.md
weiji14 Oct 29, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 15 additions & 11 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ authors:
family-names: Leong
affiliation: Victoria University of Wellington, New Zealand
orcid: https://orcid.org/0000-0003-2354-1988
- given-names: Meghan
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 +32,14 @@ authors:
family-names: Grund
affiliation: Innoplexia GmbH, Germany
orcid: https://orcid.org/0000-0001-8759-2018
- given-names: Meghan
family-names: Jones
affiliation: University of Hawai'i at Mānoa, USA
orcid: https://orcid.org/0000-0003-0180-8928
- given-names: Jiayuan
family-names: Yao
affiliation: Nanyang Technological University, Singapore
orcid: https://orcid.org/0000-0001-7036-4238
- given-names: Yohai
family-names: Magen
affiliation: Tel Aviv University
orcid: https://orcid.org/0000-0002-4892-4013
- given-names: Kathryn
family-names: Materna
affiliation: US Geological Survey, USA
Expand All @@ -52,17 +56,17 @@ authors:
family-names: Ziebarth
affiliation: GFZ German Research Centre for Geosciences, Germany
orcid: https://orcid.org/0000-0002-5190-4478
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved
- given-names: Yohai
family-names: Magen
affiliation: Tel Aviv University
orcid: https://orcid.org/0000-0002-4892-4013
- given-names: Jamie
family-names: Quinn
affiliation: University College London
orcid: https://orcid.org/0000-0002-0268-7032
- given-names: Paul
family-names: Wessel
affiliation: University of Hawai'i at Mānoa, USA
orcid: https://orcid.org/0000-0001-5708-7336
date-released: 2021-08-07
doi: 10.5281/zenodo.5162003
date-released: 2021-10-29
doi: 10.5281/zenodo.5607255
license: BSD-3-Clause
repository-code: https://github.com/GenericMappingTools/pygmt
type: software
version: 0.4.1
version: 0.5.0
24 changes: 15 additions & 9 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -137,28 +137,29 @@ Developers". Feel free to cite our work in your research using the following Bib

.. code-block::

@software{pygmt_2021_5162003,
@software{pygmt_2021_5607255,
author = {Uieda, Leonardo and
Tian, Dongdong and
Leong, Wei Ji and
Jones, Meghan and
Schlitzer, William and
Toney, Liam and
Grund, Michael and
Jones, Meghan and
Yao, Jiayuan and
Magen, Yohai and
Materna, Kathryn and
Newton, Tyler and
Anant, Abhishek and
Ziebarth, Malte and
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved
Magen, Yohai and
Quinn, Jamie aand
Wessel, Paul},
title = {{PyGMT: A Python interface for the Generic Mapping Tools}},
month = aug,
month = oct,
year = 2021,
publisher = {Zenodo},
version = {v0.4.1},
doi = {10.5281/zenodo.5162003},
url = {https://doi.org/10.5281/zenodo.5162003}
version = {v0.5.0},
doi = {10.5281/zenodo.5607255},
url = {https://doi.org/10.5281/zenodo.5607255}
}

To cite a specific version of PyGMT, go to our Zenodo page at
Expand Down Expand Up @@ -211,12 +212,17 @@ Compatibility with GMT/Python/NumPy versions
- GMT
- Python
- Numpy
* - `v0.5.0 <https://github.com/GenericMappingTools/pygmt/milestone/8>`_ (upcoming release)
* - `Dev <https://github.com/GenericMappingTools/pygmt/milestone/9>`_ (upcoming release)
- `Dev Documentation <https://www.pygmt.org/dev>`_ (reflects `main branch <https://github.com/GenericMappingTools/pygmt>`_)
- >=6.2.0
- >=3.7
- >=1.18
* - `v0.4.1 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.4.1>`_ (latest release)
* - `v0.5.0 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.5.0>`_ (latest release)
weiji14 marked this conversation as resolved.
Show resolved Hide resolved
- `v0.5.0 Documentation <https://www.pygmt.org/v0.5.0>`_
- >=6.2.0
- >=3.7
- >=1.18
* - `v0.4.1 <https://github.com/GenericMappingTools/pygmt/releases/tag/v0.4.1>`_
- `v0.4.1 Documentation <https://www.pygmt.org/v0.4.1>`_
- >=6.2.0
- >=3.7
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.5.0': 'v0.5.0',
'v0.4.1': 'v0.4.1',
'v0.4.0': 'v0.4.0',
'v0.3.1': 'v0.3.1',
Expand Down
118 changes: 118 additions & 0 deletions doc/changes.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,123 @@
# Changelog

## Release v0.5.0 (2021/10/29)

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

### Highlights

* 🎉 **Fifth minor release of PyGMT** 🎉
* Wrapped 12 GMT modules
* Standardized and reorder table inputs to be 'data, x, y, z' across functions ([#1479](https://github.com/GenericMappingTools/pygmt/pull/1479))
Comment on lines +9 to +11
Copy link
Member

Choose a reason for hiding this comment

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

Oh, and if anyone has any other item they want to highlight, feel free to suggest it to @willschlitzer.

willschlitzer marked this conversation as resolved.
Show resolved Hide resolved
* Added a gallery example showing usage of line objects from a geopandas.GeoDataFrame ([#1474](https://github.com/GenericMappingTools/pygmt/pull/1474))

willschlitzer marked this conversation as resolved.
Show resolved Hide resolved
### New Features

* Wrap blockmode ([#1456](https://github.com/GenericMappingTools/pygmt/pull/1456))
* Wrap gmtselect ([#1429](https://github.com/GenericMappingTools/pygmt/pull/1429))
* Wrap grd2xyz ([#1284](https://github.com/GenericMappingTools/pygmt/pull/1284))
* Wrap grdproject ([#1377](https://github.com/GenericMappingTools/pygmt/pull/1377))
* Wrap grdsample ([#1380](https://github.com/GenericMappingTools/pygmt/pull/1380))
* Wrap grdvolume ([#1299](https://github.com/GenericMappingTools/pygmt/pull/1299))
* Wrap nearneighbor ([#1379](https://github.com/GenericMappingTools/pygmt/pull/1379))
* Wrap project ([#1122](https://github.com/GenericMappingTools/pygmt/pull/1122))
* Wrap sph2grd ([#1434](https://github.com/GenericMappingTools/pygmt/pull/1434))
* Wrap sphdistance ([#1383](https://github.com/GenericMappingTools/pygmt/pull/1383))
* Wrap sphinterpolate ([#1418](https://github.com/GenericMappingTools/pygmt/pull/1418))
* Wrap xyz2grd ([#636](https://github.com/GenericMappingTools/pygmt/pull/636))
* Add function to import seafloor crustal age dataset ([#1471](https://github.com/GenericMappingTools/pygmt/pull/1471))
* Add pygmt.load_dataarray function ([#1439](https://github.com/GenericMappingTools/pygmt/pull/1439))

### Enhancements

* Expand table-like input options for Figure.contour ([#1531](https://github.com/GenericMappingTools/pygmt/pull/1531))
* Expand table-like input options for pygmt.surface ([#1455](https://github.com/GenericMappingTools/pygmt/pull/1455))
* Raise GMTInvalidInput exception when required z is missing ([#1478](https://github.com/GenericMappingTools/pygmt/pull/1478))
* Add support for passing pathlib.Path objects as filenames ([#1382](https://github.com/GenericMappingTools/pygmt/pull/1382))
* Allow passing a list to the 'incols' parameter for blockm, grdtrack and text ([#1475](https://github.com/GenericMappingTools/pygmt/pull/1475))
* Plot square or cube by default for OGR/GMT files with Point/MultiPoint types ([#1438](https://github.com/GenericMappingTools/pygmt/pull/1438))
* Plot square or cube by default for geopandas Point/MultiPoint types ([#1405](https://github.com/GenericMappingTools/pygmt/pull/1405))
* Add area_thresh to COMMON_OPTIONS ([#1426](https://github.com/GenericMappingTools/pygmt/pull/1426))
* Add function to import Mars dataset ([#1420](https://github.com/GenericMappingTools/pygmt/pull/1420))
* Add function to import hotspot dataset ([#1386](https://github.com/GenericMappingTools/pygmt/pull/1386))

willschlitzer marked this conversation as resolved.
Show resolved Hide resolved
### Deprecations

* pygmt.blockm*: Reorder input parameters to 'data, x, y, z' ([#1565](https://github.com/GenericMappingTools/pygmt/pull/1565))
* pygmt.surface: Reorder input parameters to 'data, x, y, z' ([#1562](https://github.com/GenericMappingTools/pygmt/pull/1562))
* Figure.contour: Reorder input parameters to 'data, x, y, z' ([#1561](https://github.com/GenericMappingTools/pygmt/pull/1561))
* Figure.plot3d: Reorder input parameters to 'data, x, y, z' ([#1560](https://github.com/GenericMappingTools/pygmt/pull/1560))
* Figure.plot: Reorder input parameters to "data, x, y" ([#1547](https://github.com/GenericMappingTools/pygmt/pull/1547))
* Figure.rose: Reorder input parameters to 'data, length, azimuth' ([#1546](https://github.com/GenericMappingTools/pygmt/pull/1546))
* Figure.wiggle: Reorder input parameter to 'data, x, y, z' ([#1548](https://github.com/GenericMappingTools/pygmt/pull/1548))
* Figure.histogram: Deprecate parameter "table" to "data" (remove in v0.7.0) ([#1540](https://github.com/GenericMappingTools/pygmt/pull/1540))
* pygmt.info: Deprecate parameter "table" to "data" (remove in v0.7.0) ([#1538](https://github.com/GenericMappingTools/pygmt/pull/1538))
* Figure.wiggle: Deprecate parameter "columns" to "incols" (remove in v0.7.0) ([#1504](https://github.com/GenericMappingTools/pygmt/pull/1504))
* pygmt.surface: Deprecate parameter "outfile" to "outgrid" (remove in v0.7.0) ([#1458](https://github.com/GenericMappingTools/pygmt/pull/1458))
* NEP29: Set minimum required version to NumPy 1.18+ ([#1430](https://github.com/GenericMappingTools/pygmt/pull/1430))

### Bug Fixes

* Allow GMTDataArrayAccessor to work on sliced datacubes ([#1581](https://github.com/GenericMappingTools/pygmt/pull/1581))
* Allow non-string color when input data is a matrix or a file for plot and plot3d ([#1526](https://github.com/GenericMappingTools/pygmt/pull/1526))
* Raise RuntimeWarning instead of an exception for irregular grid spacing ([#1530](https://github.com/GenericMappingTools/pygmt/pull/1530))
* Raise an error for zero increment grid ([#1484](https://github.com/GenericMappingTools/pygmt/pull/1484))

### Documentation

* Add CITATION.cff file for PyGMT ([#1592](https://github.com/GenericMappingTools/pygmt/pull/1592))
* Update region and projection standard docstrings ([#1510](https://github.com/GenericMappingTools/pygmt/pull/1510))
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved
* Document gmtwhich -Ga option to download to appropriate cache folder ([#1554](https://github.com/GenericMappingTools/pygmt/pull/1554))
* Add gallery example showing the usage of text symbols ([#1522](https://github.com/GenericMappingTools/pygmt/pull/1522))
* Add gallery example for grdgradient ([#1428](https://github.com/GenericMappingTools/pygmt/pull/1428))
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved
* Add gallery example for grdlandmask ([#1469](https://github.com/GenericMappingTools/pygmt/pull/1469))
* Add missing aliases to pygmt.grdgradient ([#1515](https://github.com/GenericMappingTools/pygmt/pull/1515))
* Add missing aliases to pygmt.sphdistance ([#1516](https://github.com/GenericMappingTools/pygmt/pull/1516))
* Add missing aliases to pygmt.blockmean and pygmt.blockmedian ([#1500](https://github.com/GenericMappingTools/pygmt/pull/1500))
* Add missing aliases to pygmt.Figure.wiggle ([#1498](https://github.com/GenericMappingTools/pygmt/pull/1498))
* Add missing aliases to pygmt.Figure.velo ([#1497](https://github.com/GenericMappingTools/pygmt/pull/1497))
* Add missing aliases to pygmt.surface ([#1501](https://github.com/GenericMappingTools/pygmt/pull/1501))
* Add missing aliases to pygmt.Figure.plot3d ([#1503](https://github.com/GenericMappingTools/pygmt/pull/1503))
* Add missing aliases to pygmt.grdlandmask ([#1423](https://github.com/GenericMappingTools/pygmt/pull/1423))
* Add missing aliases to pygmt.grdtrack ([#1499](https://github.com/GenericMappingTools/pygmt/pull/1499))
* Add missing aliases to pygmt.Figure.plot ([#1502](https://github.com/GenericMappingTools/pygmt/pull/1502))
* Add missing aliases to pygmt.Figure.text ([#1448](https://github.com/GenericMappingTools/pygmt/pull/1448))
* Add missing aliases to pygmt.Figure.histogram ([#1451](https://github.com/GenericMappingTools/pygmt/pull/1451))
* Add missing alias to pygmt.Figure.legend ([#1453](https://github.com/GenericMappingTools/pygmt/pull/1453))
* Add missing aliases to pygmt.Figure.rose ([#1452](https://github.com/GenericMappingTools/pygmt/pull/1452))
* Add missing alias to pygmt.Figure.grdview ([#1450](https://github.com/GenericMappingTools/pygmt/pull/1450))
* Add missing aliases to pygmt.Figure.image.py ([#1449](https://github.com/GenericMappingTools/pygmt/pull/1449))
* Add missing common options to contour ([#1446](https://github.com/GenericMappingTools/pygmt/pull/1446))
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved
* Add missing 'incols' alias to info ([#1476](https://github.com/GenericMappingTools/pygmt/pull/1476))

### Maintenance

* Add support for Python 3.10 ([#1591](https://github.com/GenericMappingTools/pygmt/pull/1591))
* Make IPython partially optional on CI to increase test coverage of figure.py ([#1496](https://github.com/GenericMappingTools/pygmt/pull/1496))
* Use mamba to install Continuous Integration dependencies ([#841](https://github.com/GenericMappingTools/pygmt/pull/841))
* Remove deprecated codecov dependency from CI ([#1494](https://github.com/GenericMappingTools/pygmt/pull/1494))
* Add the use of Flake8 to check examples and fix warnings ([#1477](https://github.com/GenericMappingTools/pygmt/pull/1477))

### Contributors

* [Dongdong Tian](https://github.com/seisman)
* [Michael Grund](https://github.com/michaelgrund)
* [Will Schlitzer](https://github.com/willschlitzer)
* [Wei Ji Leong](https://github.com/weiji14)
* [Meghan Jones](https://github.com/meghanrjones)
* [Yohai Magen](https://github.com/yohaimagen)
* [Amanda Leaman](https://github.com/arleaman)
* [@daroari](https://github.com/daroari)
* [@obaney](https://github.com/obaney)
* [@srijac](https://github.com/srijac)
* [Andrés Ignacio Torres](https://github.com/aitorres)
* [Becky Salvage](https://github.com/BeckySalvage)
* [Claudio Satriano](https://github.com/claudiodsf)
* [Jamie J Quinn](https://github.com/JamieJQuinn)
* [@carocamargo](https://github.com/carocamargo)
weiji14 marked this conversation as resolved.
Show resolved Hide resolved

----

## Release v0.4.1 (2021/08/07)

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