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.

Sign up for GitHub

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

Changelog entry for v0.5.0 #1594

Show file tree
Hide file tree
Changes from 10 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
21 changes: 13 additions & 8 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ 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
Expand All @@ -153,12 +153,12 @@ Developers". Feel free to cite our work in your research using the following Bib
Magen, Yohai and
Copy link
Member

@weiji14 weiji14 Oct 29, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

Since Yohai has 7 commits, I think we should bump his name up the list (to be after Jiayuan) on the BibTeX and CITATION.cff file. This is what I get from git shortlog -sne (after merging duplicate entries):

303  Dongdong Tian <[email protected]>
256  Leonardo Uieda <[email protected]>
160  Wei Ji <[email protected]>
105  Will Schlitzer <[email protected]>
 64  Michael Grund <[email protected]>
 58  Meghan Jones <[email protected]>
 41  dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
 32  Yao Jiayuan <[email protected]>
 15  Liam Toney <[email protected]>
  7  yohaimagen <[email protected]>
  3  kmaterna <[email protected]>
  2  Abhishek Anant <[email protected]>
  2  Amanda Leaman <[email protected]>
  2  Andrey Shmakov <[email protected]>
  2  Claudio Satriano <[email protected]>
  2  Conor Bacon <[email protected]>
  2  MichaeINeumann <[email protected]>
  2  Noor Buchi <[email protected]>
  2  Shivani chauhan <[email protected]>
  2  Tyler Newton <[email protected]>
  2  alperen-kilic <[email protected]>
  2  carocamargo <[email protected]>
  2  daroari <[email protected]>
  2  obaney <[email protected]>
  2  srijac <[email protected]>
  1  Alicia Ngoc Diep Ha <[email protected]>
  1  Andrés Ignacio Torres <[email protected]>
  1  Becky Salvage <[email protected]>
  1  Brook <[email protected]>
  1  Cody Woodson <[email protected]>
  1  Emily McMullan <[email protected]>
  1  Jamie J Quinn <[email protected]>
  1  Kadatatlu Kishore <[email protected]>
  1  Loïc Houpert <[email protected]>
  1  Malte Ziebarth <[email protected]>
  1  Mark Wieczorek <[email protected]>
  1  Philipp Loose <[email protected]>

Also happy to debate on whether we switch any of the ordering (e.g. make @seisman first author 🙂)

Copy link
Contributor Author

@willschlitzer willschlitzer Oct 29, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

I'm fine with either way of doing it. I know that we have previously put @leouieda at the front because he created this project, but I think @seisman, @weiji14, and @meghanrjones are the three most active on this project at this time when it comes to providing feedback and completing reviews. I moved both Meghan and Yohai up in the list.

Copy link
Member

@weiji14 weiji14 Oct 29, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

Yep, the order looks ok to me now (though happy to discuss). Please also update the CITATION.cff file with the new author order (and apply the patch from #1592 (comment)) as mentioned in #1594 (comment).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done in bbbc0ac

Copy link
Member

Choose a reason for hiding this comment

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

A bit late but just wanted to say that I'm perfectly happy not being first since @seisman @weiji14 @meghanrjones and others deserve it more than I do 👍🏽 Creating something is easy, keeping it going and growing like this is where the real work is 🙂

Copy link
Member

Choose a reason for hiding this comment

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

Thanks Leo for chiming in! I would argue that you still deserve the first spot since the original GMT C to Python interface (via ctypes) is so foundational (some of that 4+ year old code is still more or less intact at https://github.com/GenericMappingTools/pygmt/blame/v0.5.0/pygmt/clib/session.py and working!!!), and this is what makes this 'PyGMT' package so good compared to the other gmtpy/pygmt wrappers people have tried to come up with previously.

But again, I don't want to get into an author ordering debate, I'm just as happy being on third place, last place, alphabetically ordered or have a random number generator sort things out. We've discussed the AUTHORSHIP.md policy before at #726 (comment), and could edit it again if needed, especially when the time comes closer to getting a software publication out.

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 +211,17 @@ Compatibility with GMT/Python/NumPy versions
- GMT
- Python
- Numpy
* - `v0.5.0 <https://github.com/GenericMappingTools/pygmt/milestone/8>`_ (upcoming release)
- `Dev Documentation <https://www.pygmt.org/dev>`_ (reflects `main branch <https://github.com/GenericMappingTools/pygmt>`_)
* - `Dev <https://github.com/GenericMappingTools/pygmt/milestone/9>`_ (upcoming release)
- `Dev Documentation <https://www.pygmt.org/v0.5.0>`_
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved
- >=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
View file
Open in desktop
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
117 changes: 117 additions & 0 deletions doc/changes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,122 @@
# 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** 🎉
* Add support for Python 3.10 ([#1591](https://github.com/GenericMappingTools/pygmt/pull/1591))
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved

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

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

### 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))
* Add the 'incols' alias to info ([#1476](https://github.com/GenericMappingTools/pygmt/pull/1476))
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved
* 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

* 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 a gallery example showing the usage of text symbols ([#1522](https://github.com/GenericMappingTools/pygmt/pull/1522))
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved
* 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 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
* 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 gallery example for grdlandmask ([#1469](https://github.com/GenericMappingTools/pygmt/pull/1469))
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved
* 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

### Maintenance

* Add support Python 3.10 ([#1591](https://github.com/GenericMappingTools/pygmt/pull/1591))
weiji14 marked this conversation as resolved.
Show resolved Hide resolved
* 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)
* [Will Schlitzer](https://github.com/willschlitzer)
* [Michael Grund](https://github.com/michaelgrund)
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved
* [Wei Ji Leong](https://github.com/weiji14)
* [Meghan Jones](https://github.com/meghanrjones)
* [@yohaimagen](https://github.com/yohaimagen)
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved
* [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