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.2.0 #599

Merged
merged 7 commits into from
Sep 12, 2020
Merged

Changelog entry for v0.2.0 #599

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c5cf4db
Changelog entry for v0.2.0
weiji14 Sep 11, 2020
2909271
Merge some maintenance related items
weiji14 Sep 11, 2020
2647ab1
Merge remote-tracking branch 'upstream/master' into changelog/v0.2.0
weiji14 Sep 11, 2020
be6dac8
Add changelog entry for link to try-gmt binder repository
weiji14 Sep 11, 2020
b776e88
Format Pull Request links using sed
weiji14 Sep 11, 2020
3c94765
Add reserved Zenodo DOI badge for v0.2.0
weiji14 Sep 11, 2020
4ba4bd8
Set release date to 2020/09/12
weiji14 Sep 12, 2020
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
1 change: 1 addition & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,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.2.0 <https://www.pygmt.org/v0.2.0>`__
* `v0.1.2 <https://www.pygmt.org/v0.1.2>`__
* `v0.1.1 <https://www.pygmt.org/v0.1.1>`__
* `v0.1.0 <https://www.pygmt.org/v0.1.0>`__
Expand Down
76 changes: 76 additions & 0 deletions doc/changes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,82 @@
Changelog
=========

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

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3781524.svg
:alt: Digital Object Identifier for the Zenodo archive
:target: https://doi.org/10.5281/zenodo.3781524
Copy link
Member Author

Choose a reason for hiding this comment

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

Just to make sure someone (other than me) can do it, can one of @GenericMappingTools/python reserve a new version DOI under the PyGMT banner at https://zenodo.org/record/3930577? Just click on the green "New version" button (see sceenshot).

PyGMT Zenodo page

This will take you to a page where there should be a 'Reserve DOI' button somewhere. Click on that, and copy the DOI link here!

Copy link
Member

Choose a reason for hiding this comment

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

image

I can't see it.

Copy link
Member Author

Choose a reason for hiding this comment

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

Hmm, did you login with Github? I'm not quite sure how the permissions work on Zenodo. Might need to email them.

Copy link
Member

Choose a reason for hiding this comment

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

Yes, I log in using my github acccout. I can see the PyGMT project in my account, but it's off by default.
image.

After turning it on, I see:
image

Copy link
Member Author

Choose a reason for hiding this comment

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

Ok, bit of a long story, but there were some double ups with the PyGMT release DOIs because I tried to reserve a DOI before a release, and put that in the release notes, but when we make a release, the automated Github integration would just ignore that reserved DOI and make a new one. So I had to email Zenodo and delete those duplicated DOIs. (Will forward you the email chain in a bit).

Copy link
Member Author

Choose a reason for hiding this comment

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

Ok email sent. Just to clarify, there's 2 options that I know of to make a Zenodo DOI, each with pros/cons (see also FAQs at https://help.zenodo.org/):

  1. Use the automated Github integration:
  • Pro: It's automated, publishing a release creates the DOI automatiically
  • Con: We don't know the DOI number beforehand, so can't put it into the release notes. Also, I couldn't manage to link it to our current permanent/concept DOI at https://doi.org/10.5281/zenodo.3781524.
  1. Manually reserve a DOI (what was done for PyGMT v0.1.x):
  • Pro: We know the DOI beforehand, so can put it into our release notes. Also more control with the metadata information.
  • Con: It's not automated, I had to manually download the pygmt-v0.1.x.zip file, and upload it to Zenodo. Also as we found out, maybe it's linked only to my account?!!

So what should we do here?

Copy link
Member Author

@weiji14 weiji14 Sep 11, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

Maybe I'll just reserve the DOI again for this v0.2.0 release, and you (@seisman) or someone else can do it next time (will open an issue to keep track of it), since it might take a few days to email Zenodo and sort things out. Don't want to delay this release any longer.

Copy link
Member

Choose a reason for hiding this comment

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

OK to me.


Highlights:

* 🎉 **Second minor release of PyGMT** 🎉
* Minimum required GMT version is now 6.1.1 or newer (#577)
* Plotting xarray grids using grdimage and grdview should not crash anymore and works for most cases (#560)
* Easier time-series plots with support for datetime-like inputs to plot (#464) and the region argument (#562)

New Features:

* Wrap GMT_Put_Strings to pass str columns into GMT C API directly (#520)
* Wrap meca (#516)
* Wrap x2sys_init and x2sys_cross (#546)
* Let grdcut() accept xarray.DataArray as input (#541)
* Initialize a GMTDataArrayAccessor (#500)

Enhancements:

* Allow passing in pandas dataframes to x2sys_cross (#591)
* Sensible array outputs for pygmt info (#575)
* Allow pandas.DataFrame table and 1D/2D numpy array inputs into pygmt.info (#574)
* Add auto-legend feature to grdcontour and contour (#568)
* Add common alias verbose (V) (#550)
* Let load_earth_relief() support all resolutions and optional subregion (#542)
* Allow load_earth_relief() to load pixel or gridline registered data (#509)

Documentation:

* Improve docstring of data_kind() to include xarray grid (#588)
* Improve the documentation of Figure.shift_origin() (#536)
* Fix the grdtrack example to avoid crashes on macOS (#531)
* Add shading to grdview gallery example (#506)

Bug Fixes:

* Ensure surface and grdcut loads GMTDataArray accessor info into xarray (#539)
* Raise an error if short- and long-form arguments coexist (#537)
* Fix the grdtrack example to avoid crashes on macOS (#531)
* Properly allow for either pixel or gridline registered grids (#476)

Maintenance:

* Add a test for xarray shading (#581)
* Remove expected failures on grdview tests (#589)
* Redesign check_figures_equal testing function to be more explicit (#590)
* Cut Windows CI build time in half to 15 min (#586)
* Add a test for Session.write_data() writing netCDF grids (#583)
* Add a test to make sure shift_origin does not crash (#580)
* Add testing.check_figures_equal to avoid storing baseline images (#555)
* Eliminate unnecessary jobs from Travis CI (#567)
* Improve the workflow to test both GMT master and 6.1 branches (#554)
* Automatically cancel in-progress CI runs of old commits (#544)
* Github Actions CI for testing GMT master branch (#485)
* Remove the Stickler CI configuration file (#538)
* Cache GMT remote data as artifacts on Github (#530)
* Run style checks using GitHub Actions instead of Azure Pipelines (#519)
* Bump the required minimum GMT version to 6.1.0 (#507)
weiji14 marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Member

Choose a reason for hiding this comment

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

Some items in the maintenance can be merged into one item. For example, there are many items about the migration from Azure Pipelines to GitHub Actions.

Copy link
Member Author

Choose a reason for hiding this comment

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

Ok just need to be careful that we keep the format as (#XYZ) otherwise our sed command won't work 😃

* Eliminate Azure Pipelines CI jobs, use GitHub Actions instead (#513)
* Let pytest generate both HTML and XML coverage reports (#512)
* Run Continuous Integration tests on Github Actions (#475)

Contributors:

* `Dongdong Tian <https://github.com/seisman>`__
* `Wei Ji Leong <https://github.com/weiji14>`__
* `Tyler Newton <https://github.com/tjnewton>`__
* `Liam Toney <https://github.com/liamtoney>`__

----

Release v0.1.2 (2020/07/07)
---------------------------

Expand Down