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.3.1 release #1047

Merged
merged 22 commits into from
Mar 14, 2021
Merged

Changelog entry for v0.3.1 release #1047

Show file tree
Hide file tree
Changes from 21 commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
a38d9d3
Update README.rst for v0.3.1 release
willschlitzer Mar 13, 2021
9d058a4
Update version_switch.js for v0.3.1 release
willschlitzer Mar 13, 2021
a783324
Add changelog entry to changes.md
willschlitzer Mar 13, 2021
6763056
Minor change log updates
willschlitzer Mar 13, 2021
46d58f3
Update doc/changes.md
willschlitzer Mar 13, 2021
4a9ebef
Update README.rst
willschlitzer Mar 13, 2021
001ab97
add Alicia Ngoc Diep Ha to contributors
willschlitzer Mar 14, 2021
956a8dc
Merge remote-tracking branch 'origin/v0.3.1-release' into v0.3.1-release
willschlitzer Mar 14, 2021
88a0f8a
add Tawanda Moyo to contributors
willschlitzer Mar 14, 2021
27c5f50
Apply suggestions from code review
willschlitzer Mar 14, 2021
ccca7e6
Merge branch 'master' into v0.3.1-release
willschlitzer Mar 14, 2021
8f10941
Update release highlights
willschlitzer Mar 14, 2021
e377ead
change wording
willschlitzer Mar 14, 2021
d31a4ea
Apply suggestions from code review
willschlitzer Mar 14, 2021
444ef30
Update v0.3.1 highlights
willschlitzer Mar 14, 2021
c1ce366
Update doc/changes.md
willschlitzer Mar 14, 2021
85f8553
Update v0.3.1 highlights wording
willschlitzer Mar 14, 2021
80f6ee7
Merge remote-tracking branch 'origin/v0.3.1-release' into v0.3.1-release
willschlitzer Mar 14, 2021
5228afa
Update doc/changes.md
willschlitzer Mar 14, 2021
958ce13
reorganize contributor list
willschlitzer Mar 14, 2021
7f7f968
Merge remote-tracking branch 'origin/v0.3.1-release' into v0.3.1-release
willschlitzer Mar 14, 2021
8fef314
reorganize author list
willschlitzer Mar 14, 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
17 changes: 10 additions & 7 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,24 +154,26 @@ Developers". Feel free to cite our work in your research using the following Bib

.. code-block::

@software{pygmt_2021_4522136,
@software{pygmt_2021_4592991,
author = {Uieda, Leonardo and
Tian, Dongdong and
Leong, Wei Ji and
Toney, Liam and
Schlitzer, William and
Grund, Michael and
Yao, Jiayuan and
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Toney, Liam and
Schlitzer, William and
Grund, Michael and
Yao, Jiayuan and
Schlitzer, William and
Yao, Jiayuan and
Grund, Michael and
Toney, Liam and

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I had based this off number of commits yesterday; I'll put
Toney, Liam and Schlitzer, William and Yao, Jiayuan and Grund, Michael and

In the v0.3.0 release we put @liamtoney up higher because of his ROSES video, which may not count towards his commits but has significantly enhanced the project. Ping @GenericMappingTools/python for input, but I think he should remain where he is in the order because he is spearheading the SciPy session.

Copy link
Member

Choose a reason for hiding this comment

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

Following @weiji14 , I checked Citing PyGMT and authorship on Zenodo archives of releases at AUTHORSHIP.md:

The order of authors will be defined by the number of commits to the repository (git shortlog -sne). The order can also be changed on a case-by-case basis.

Yes, on a first order, we sort things by the number of commits. But pay attention to the next sentence "The order can also be changed on a case-by-case basis". The idea is that contributions are not just about commits but also the other things people do. For example, Liam put a lot of work into the ROSES tutorial (the video on the front page) and Meghan has done lots of things behind the scenes such as funding applications and setting up accounts.

I don't want to get too fired up about name ordering, but it's really up to you all to negotiate what you think is best. Just stating that there are other factors to consider :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Changes pushed in 8fef314

Copy link
Member

@core-man core-man Mar 14, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

That's reasonable. I also think Liam and Meghan have conducted a lot of work beyond just code commit. Good to know we can pay attention to those contributions a lot. Actually, I begin to know PyGMT from his ROSES tutorial. 😄

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Actually, I begin to know PyGMT from his ROSES tutorial.

Me too! Thanks Liam!

Copy link
Member

Choose a reason for hiding this comment

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

Everythin fine for me 😉.

Jones, Meghan and
Materna, Kathryn and
Newton, Tyler and
Ziebarth, Malte and
Jones, Meghan and
Wessel, Paul},
title = {{PyGMT: A Python interface for the Generic Mapping Tools}},
month = feb,
month = mar,
year = 2021,
publisher = {Zenodo},
version = {v0.3.0},
doi = {10.5281/zenodo.4522136},
url = {https://doi.org/10.5281/zenodo.4522136}
version = {v0.3.1},
doi = {10.5281/zenodo.4592991},
url = {https://doi.org/10.5281/zenodo.4592991}
}

To cite a specific version of PyGMT, go to our Zenodo page at
Expand Down Expand Up @@ -218,6 +220,7 @@ Documentation for other versions
* `Development <https://www.pygmt.org/dev>`__ (reflects the *master* branch on
GitHub)
* `Latest release <https://www.pygmt.org/latest>`__
* `v0.3.1 <https://www.pygmt.org/v0.3.1>`__
* `v0.3.0 <https://www.pygmt.org/v0.3.0>`__
* `v0.2.1 <https://www.pygmt.org/v0.2.1>`__
* `v0.2.0 <https://www.pygmt.org/v0.2.0>`__
Expand All @@ -232,7 +235,7 @@ Compatibility with Python and GMT versions
======= ========== =========
PyGMT GMT Python
======= ========== =========
0.3.0 >=6.1.1 >=3.7
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
0.1.x >=6.0.0 3.6 - 3.8
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.3.1': 'v0.3.1',
'v0.3.0': 'v0.3.0',
'v0.2.1': 'v0.2.1',
'v0.2.0': 'v0.2.0',
Expand Down
69 changes: 69 additions & 0 deletions doc/changes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,74 @@
# Changelog

## Release v0.3.1 (2021/03/14)

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

### Highlights

* 🎉 **Multiple bug fixes and an improved gallery** 🎉
* Reorganized gallery examples into new categories ([#995](https://github.com/GenericMappingTools/pygmt/pull/995))
* Added gallery examples for plotting vectors ([#950](https://github.com/GenericMappingTools/pygmt/pull/950), [#890](https://github.com/GenericMappingTools/pygmt/pull/890))
* Last version to support GMT 6.1.1, future PyGMT versions will require GMT 6.2.0 or newer

### Enhancements

* Support passing a sequence to the spacing parameter of pygmt.info() ([#1031](https://github.com/GenericMappingTools/pygmt/pull/1031))

### Bug Fixes

* Fix issues in loading GMT's shared library ([#977](https://github.com/GenericMappingTools/pygmt/pull/977))
* Let pygmt.info load datetime columns into a str dtype array ([#960](https://github.com/GenericMappingTools/pygmt/pull/960))
* Check invalid combinations of resolution and registration in load_earth_relief() ([#965](https://github.com/GenericMappingTools/pygmt/pull/965))
* Open figures using the associated application on Windows ([#952](https://github.com/GenericMappingTools/pygmt/pull/952))
* Fix bug that stops Figure.coast from plotting with only dcw parameter ([#910](https://github.com/GenericMappingTools/pygmt/pull/910))

### Documentation

* Add a gallery example showing different line front styles ([#1022](https://github.com/GenericMappingTools/pygmt/pull/1022))
* Add a gallery example for a double y-axes graph ([#1019](https://github.com/GenericMappingTools/pygmt/pull/1019))
* Add a gallery example of inset map showing a rectangle region ([#1020](https://github.com/GenericMappingTools/pygmt/pull/1020))
* Add a gallery example to show coloring of points by categories ([#1006](https://github.com/GenericMappingTools/pygmt/pull/1006))
* Add gallery example showing different polar projection use cases ([#955](https://github.com/GenericMappingTools/pygmt/pull/955))
* Add underscore guideline to CONTRIBUTING.md ([#1034](https://github.com/GenericMappingTools/pygmt/pull/1034))
* Add instructions to upgrade installed PyGMT version ([#1029](https://github.com/GenericMappingTools/pygmt/pull/1029))
* Improve the docstring of the pygmt package ([#1016](https://github.com/GenericMappingTools/pygmt/pull/1016))
* Add common alias coltypes (-f) for specifying i/o data types ([#994](https://github.com/GenericMappingTools/pygmt/pull/994))
* Expand documentation linking in CONTRIBUTING.md ([#802](https://github.com/GenericMappingTools/pygmt/pull/802))
* Write changelog in markdown using MyST ([#941](https://github.com/GenericMappingTools/pygmt/pull/941))
* Update web font to Atkinson Hyperlegible ([#938](https://github.com/GenericMappingTools/pygmt/pull/938))
* Improve the gallery example for datetime inputs ([#919](https://github.com/GenericMappingTools/pygmt/pull/919))

### Maintenance

* Refactor plot and plot3d to use virtualfile_from_data ([#990](https://github.com/GenericMappingTools/pygmt/pull/990))
* Explicitly exclude unnecessary files in source distributions ([#999](https://github.com/GenericMappingTools/pygmt/pull/999))
* Refactor grd modules to use virtualfile_from_data ([#992](https://github.com/GenericMappingTools/pygmt/pull/992))
* Refactor info and grdinfo to use virtualfile_from_data ([#961](https://github.com/GenericMappingTools/pygmt/pull/961))
* Onboarding maintainer checklist ([#773](https://github.com/GenericMappingTools/pygmt/pull/773))
* Add comprehensive tests for pygmt.clib.loading.clib_full_names ([#872](https://github.com/GenericMappingTools/pygmt/pull/872))
* Add a workflow checking links in plaintext and HTML files ([#634](https://github.com/GenericMappingTools/pygmt/pull/634))
* Remove nbsphinx extension ([#931](https://github.com/GenericMappingTools/pygmt/pull/931))
* Improve the error message for loading an old version of the GMT library ([#925](https://github.com/GenericMappingTools/pygmt/pull/925))
* Move requirements-dev.txt dependencies to environment.yml ([#812](https://github.com/GenericMappingTools/pygmt/pull/812))
* Ensure proper non-dev version string when publishing to PyPI ([#900](https://github.com/GenericMappingTools/pygmt/pull/900))
* Run tests in a single CI job (Ubuntu + Python 3.9) for draft PRs ([#906](https://github.com/GenericMappingTools/pygmt/pull/906))

### Contributors

* [Dongdong Tian](https://github.com/seisman)
* [Jiayuan Yao](https://github.com/core-man)
* [Wei Ji Leong](https://github.com/weiji14)
* [Meghan Jones](https://github.com/meghanrjones)
* [Michael Grund](https://github.com/michaelgrund)
* [Will Schlitzer](https://github.com/willschlitzer)
* [Liam Toney](https://github.com/liamtoney)
* [Kathryn Materna](https://github.com/kmaterna)
* [Alicia Ngoc Diep Ha](https://github.com/aliciaha1997)
* [Tawanda Moyo](https://github.com/tawandamoyo)

----

## Release v0.3.0 (2021/02/15)

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