Skip to content
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
ccb9aa8
Add v0.3.0 to version_switch.js
willschlitzer Feb 14, 2021
9fe24fb
Update citation information
willschlitzer Feb 14, 2021
1081fb2
Update compatibility and doicumentation links
willschlitzer Feb 14, 2021
6ec6a3a
Apply suggestions from code review
willschlitzer Feb 14, 2021
fc21cb8
Merge branch 'master' into v0.3.0-release
weiji14 Feb 14, 2021
36b72e9
Initial draft changelog from Release Drafter
weiji14 Feb 15, 2021
29cbefc
Merge some changelog entries together
weiji14 Feb 15, 2021
4122c73
Apply suggestions from code review
weiji14 Feb 15, 2021
6d0208d
Add highlights and list out contributor names ordered by no. of commits
weiji14 Feb 15, 2021
e944f1d
Group changes in the "Maintenance" section
seisman Feb 15, 2021
286fc4b
Fix two issues in the previous commit
seisman Feb 15, 2021
21593d9
Group changes in the 'Documentation' section and update some titles
seisman Feb 15, 2021
32d6fc4
Apply suggestions from code review
willschlitzer Feb 15, 2021
5a6c4bd
Merge branch 'master' into v0.3.0-release
willschlitzer Feb 15, 2021
a02d9e3
Minor change log wording change
willschlitzer Feb 15, 2021
dc7eaa0
Merge branch 'master' into v0.3.0-release
willschlitzer Feb 15, 2021
a98ca1e
Run sed command to format links
willschlitzer Feb 15, 2021
32047f9
Merge remote-tracking branch 'origin/v0.3.0-release' into v0.3.0-release
willschlitzer Feb 15, 2021
98097bc
Run sed command to format links; format fixes
willschlitzer Feb 15, 2021
23bf843
format fixes
willschlitzer Feb 15, 2021
dae9804
Apply suggestions from code review
willschlitzer Feb 15, 2021
8a20f3a
Fix a typo
weiji14 Feb 15, 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: 11 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -153,20 +153,23 @@ Developers". Feel free to cite our work in your research using the following Bib

.. code-block::

@software{uieda_leonardo_2020_4025418,
@software{pygmt_2021_4522136,
author = {Uieda, Leonardo and
Tian, Dongdong and
Leong, Wei Ji and
Toney, Liam and
Schlitzer, William and
Grund, Michael and
Newton, Tyler and
Jones, Meghan and
Wessel, Paul},
title = {{PyGMT: A Python interface for the Generic Mapping Tools}},
month = nov,
year = 2020,
month = feb,
year = 2021,
publisher = {Zenodo},
version = {v0.2.1},
doi = {10.5281/zenodo.4253459},
url = {https://doi.org/10.5281/zenodo.4253459}
version = {v0.3.0},
doi = {10.5281/zenodo.4522136},
url = {https://doi.org/10.5281/zenodo.4522136}
}

To cite a specific version of PyGMT, go to our Zenodo page at
Expand Down Expand Up @@ -212,6 +215,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.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>`__
* `v0.1.2 <https://www.pygmt.org/v0.1.2>`__
Expand All @@ -225,6 +229,7 @@ Compatibility with Python and GMT versions
======= ========== =========
PyGMT GMT Python
======= ========== =========
0.3.0 >=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
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.0': 'v0.3.0',
'v0.2.1': 'v0.2.1',
'v0.2.0': 'v0.2.0',
'v0.1.2': 'v0.1.2',
Expand Down
107 changes: 107 additions & 0 deletions doc/changes.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,111 @@
Changelog
=========

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

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.4522136.svg
:alt: Digital Object Identifier for the Zenodo archive
:target: https://doi.org/10.5281/zenodo.4522136

Highlights

*
Copy link
Member

Choose a reason for hiding this comment

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

We'll need to add 3 to 4 lines for the highlights section here. How about:

Suggested change
*
* 🎉 **Third minor release of PyGMT** 🎉
* Wrap inset (#788) for making overview maps and subplot (#822) for multi-panel figures
* Apply standardized formatting conventions (#775) across most documentation pages
* Drop Python 3.6 support (#699) so PyGMT now requires Python 3.7 or newer

Feel free to suggest edits in the wording. I'm also thinking whether to mention the upcoming drop in support for GMT 6.1.1 (once GMT 6.2.0 is out, something for PyGMT v0.4.0) and/or NEP29 adoption (#690). Might depend on whether we want a v0.3.1 release?

Copy link
Member

@seisman seisman Feb 15, 2021

Choose a reason for hiding this comment

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

I'm also thinking whether to mention the upcoming drop in support for GMT 6.1.1 (once GMT 6.2.0 is out, something for PyGMT v0.4.0) and/or NEP29 adoption

Don't try to predict the future. 😄

Copy link
Member

Choose a reason for hiding this comment

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

Ok, will surprise our users then 😸


New Features

* Wrap grd2cpt (#803), inset (#788), and subplot (#822)
* Let Figure.text() support record-by-record transparency (#716)
* Provide basic support for FreeBSD (#700)

Enhancements

* Let load_earth_relief() support 'region' argument for all resolutions (#873)
* Detect ghostscript and default image viewer in FreeBSD (#878)
* Improve how PyGMT finds the GMT library (#702)
* Add dcw (#765) and lakes (#781) aliases to Figure.coast
* Add the shading parameter to colorbar() in base_plotting.py (#752)

Documentation

* Update the docstrings in the plotting modules (#881)
* Update the doc strings in the non-plotting modules (#882)
* Add alias annotation (A) to Figure.contour() (#883)
* Revise pygmt development installation instructions (#865)
* Update the docstrings of common aliases (#862)
* Add common alias panel (-c) to all plotting functions (#853)
* Update forum link to pygmt specific category (#858)
* Wrap grdinfo aliases (#799)
* Add sphinx-copybutton extension to easily copy codes (#838)
* Add additional video link in text for clarity (#836)
* Choosing the thumbnail figures in tutorials (#826)
* Add a gallery example for logo (#823)
* Update axis label explanation in frames tutorial (#820)
* Update GMT arguments in coast doc strings (#798)
* Add guidelines for types of tests to write (#796)
* Recommend using SI units in documentation (#795)
* Create gallery example for datetime inputs (#779)
* Update GMT argument in the azimuthal (#776), conic (#780), cylindric (#789), and miscellaneous (#790) projections gallery to doc standards
* Add an example for plotting multi-parameter symbols (#772)
* Add a gallery example for the fig.image() method (#777)
* Add a gallery example of setting line colors with a custom CPT (#774)
* Add a table for compatibility of PyGMT with Python and GMT (#763)
* Add description for the "columns" arguments (#766)
* Add table for projections (#753)
* Add cylindric (#761), conic projection (#721, #757), miscellaneous projections descriptions (#723, #762), logarithmic and power projections (#742) to gallery
* Add projection description for Lambert Azimuthal Equal-Area (#760)
* Change text when GMTInvalidInput error is raised for basemap (#729)
* Add non-geographic plots to projection gallery (#728)
* Adding cylindrical projections to gallery (#727)
* Add tutorials, for adding a map title (#720), plotting Earth relief (#712), 3D perspective image (#743), contour maps (#705), plotting lines tutorial (#741), region arguments (#800)
* Add frame and cmap to the colorbar parameters list (#709)
* Add frame as a parameter on the grdview documentation (#707)

Bug Fixes

* Fix a bug of Figure.text() when "text" is a non-string array (#724)
* Fix the error message when IPython is not available (#701)

Maintenance

* Add dependabot to keep GitHub Actions up to date (#861)
* Add authorship policy (#726)
* Move plotting functions to separate modules (#808)
* Skip workflows in PRs if only non-source-code files are changed (#839)
* Move non-plotting modules to separate files in src directory (#832)
* Show test execution times in pytest (#835)
* Add slash command '/test-gmt-dev' to test GMT dev version (#831)
* Add tests for grdfilter (#809)
* Improve the error message when PyGMT fails to load the GMT library (#814)
* Add tests for GMTInvalidInput for figure.py (#810)
* Split meca into a standalone module from base_plotting.py (#686)
* Update CONTRIBUTING.md with formatting conventions (#775)
* Use args_in_kwargs for basemap error raising (#797)
* Add docformatter to format plain text in docstrings (#642)
* Add GMTInvalidInput Error for Figure.coast (#787)
* Add args_in_kwargs function (#791)
* Add a CI job testing GMT master branch on Windows (#756)
* Add isort to sort imports alphabetically (#745)
* Convert relative imports to absolute imports (#754)
* Add a Makefile target 'distclean' for deleting project metadata files (#744)
* Add test test_basemap_map_scale (#739)
* Check files for UNIX-style line breaks and 644 permission (#736)
* Rename vercel configuration file from now.json to vercel.json (#738)
* Migrate pytest configurations to pyproject.toml (#725)
* Migrate documentation deployment from Travis CI to GitHub Actions (#713)
* Switch from versioneer to setuptools-scm (#695)
* Migrate coverage configurations to pyproject.toml (#667)

Deprecations

* Drop Python 3.6 support (#699)

Contributors

@liamtoney, @meghanrjones, @michaelgrund, @seisman, @weiji14 and @willschlitzer
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
@liamtoney, @meghanrjones, @michaelgrund, @seisman, @weiji14 and @willschlitzer
People with a "+" by their name contributed a patch for the first time.
* `Dongdong Tian <https://github.com/seisman>`__
* `Liam Toney <https://github.com/liamtoney>`__
* `Meghan Jones <https://github.com/meghanrjones>`__ +
* `Michael Grund <https://github.com/michaelgrund>`__ +
* `Wei Ji Leong <https://github.com/weiji14>`__
* `Will Schlitzer <https://github.com/willschlitzer>`__ +

Two thoughts here:

  1. Should we sort alphebetically by name (as above), or by number of commits (old style before).
  2. Some projects (e.g. geopandas) add a little note with a plus (+) to indicate people's first contribution, should we add it here?

Copy link
Member

Choose a reason for hiding this comment

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

Two thoughts here:

  1. Should we sort alphebetically by name (as above), or by number of commits (old style before).

I'm fine with both, but prefer "number of commits".

  1. Some projects (e.g. geopandas) add a little note with a plus (+) to indicate people's first contribution, should we add it here?

I saw it in many projects, but is there an easy way to know if someone makes his/her first contribution to this release?

Copy link
Member

Choose a reason for hiding this comment

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

  1. Some projects (e.g. geopandas) add a little note with a plus (+) to indicate people's first contribution, should we add it here?

I saw it in many projects, but is there an easy way to know if someone makes his/her first contribution to this release?

Other than remembering people, there's probably a complicated git command that could do it. Happy to leave it without the plus.

I'm fine with both, but prefer "number of commits".

I thought your name would be on top either way, but git shortlog HEAD...v0.2.1 -sne gives:

    58  Will Schlitzer <schlitzer90@gmail.com>
    54  Dongdong Tian <seisman.info@gmail.com>
     9  Wei Ji <23487320+weiji14@users.noreply.github.com>
     7  Michael Grund <michael_grund@gmx.de>
     6  dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
     3  Liam Toney <38269494+liamtoney@users.noreply.github.com>
     3  Meghan Jones <meghanj@hawaii.edu>
     3  Wei Ji <weiji.leong@vuw.ac.nz>

and so the order would be:

Suggested change
@liamtoney, @meghanrjones, @michaelgrund, @seisman, @weiji14 and @willschlitzer
* `Will Schlitzer <https://github.com/willschlitzer>`__
* `Dongdong Tian <https://github.com/seisman>`__
* `Wei Ji Leong <https://github.com/weiji14>`__
* `Michael Grund <https://github.com/michaelgrund>`__
* `Liam Toney <https://github.com/liamtoney>`__
* `Meghan Jones <https://github.com/meghanrjones>`__

Copy link
Member

Choose a reason for hiding this comment

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

Looks better to me.

Copy link
Member

Choose a reason for hiding this comment

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

Alright, I'll commit the change, but we should document this (order by number of commits) for when we deal with #885.

Copy link
Member

Choose a reason for hiding this comment

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

Running git shortlog HEAD...v0.2.1 -sne on the master branch gives me:

    54  Dongdong Tian <seisman.info@gmail.com>
    54  Will Schlitzer <schlitzer90@gmail.com>
     9  Wei Ji <23487320+weiji14@users.noreply.github.com>
     7  Michael Grund <michael_grund@gmx.de>
     6  dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
     3  Liam Toney <38269494+liamtoney@users.noreply.github.com>
     3  Meghan Jones <meghanj@hawaii.edu>

Not trying to be listed at the top, just curious why our results are different 😂

Copy link
Member

Choose a reason for hiding this comment

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

Hmm, I was probably on a different branch (which explains why it had my unversity vuw.ac.nz email). I think you'll get bumped down after @willschlitzer merges this PR though 🤣

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Dare I suggest that as a GMT developer and long-time PyGMT maintainer, I think @seisman has definitely earned the first spot!


----

Release v0.2.1 (2020/11/14)
---------------------------

Expand Down Expand Up @@ -76,6 +181,8 @@ This release contains contributions from:
* `Conor Bacon <https://github.com/hemmelig>`__
* `carocamargo <https://github.com/carocamargo>`__

----

Release v0.2.0 (2020/09/12)
---------------------------

Expand Down