Skip to content

Change test_grdgradient.py to use static_earth_relief - #1679

Merged
seisman merged 6 commits into
mainfrom
remove-grdinfo/grdgradient
Feb 15, 2022
Merged

Change test_grdgradient.py to use static_earth_relief#1679
seisman merged 6 commits into
mainfrom
remove-grdinfo/grdgradient

Conversation

@willschlitzer

Copy link
Copy Markdown
Contributor

Description of proposed changes

This PR refactors the pygmt.grdgradient tests to use xarray.testing.assert_allclose() rather than pygmt.grdinfo() in preparation for the deprecation associated with better return values for grdinfo (#593).

Fixes #

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
  • If adding new functionality, add an example to docstrings or tutorials.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

  • /format: automatically format and lint the code
  • /test-gmt-dev: run full tests on the latest GMT development version

@willschlitzerwillschlitzer added maintenance Boring but important stuff for the core devs skip-changelog Skip adding Pull Request to changelog labels Dec 20, 2021
@willschlitzerwillschlitzer added this to the 0.6.0 milestone Dec 20, 2021
@willschlitzerwillschlitzer self-assigned this Dec 20, 2021
@maxrjones

Copy link
Copy Markdown
Member

Just a quick note for while you're updating the open PRs that you could use an even smaller subregion from @static_earth_relief to make the fixture_grid_result contents simpler.

Comment threadpygmt/tests/test_grdgradient.py Outdated
npt.assert_allclose(temp_grid.max(), 0.0575332976)
npt.assert_allclose(temp_grid.median(), 0.0004889865522272885)
npt.assert_allclose(temp_grid.mean(), 0.0028633063193410635)
result = grdgradient(grid=grid, azimuth=10, direction="c")

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

In future GMT releases, azimuth and direction will not be allowed together because the two options are contradictory (see discussion in GenericMappingTools/gmt#6327). Sorry for the extra work, but I recommend updating this test to use only one of these two parameters.

@willschlitzer

Copy link
Copy Markdown
ContributorAuthor

Just a quick note for while you're updating the open PRs that you could use an even smaller subregion from @static_earth_relief to make the fixture_grid_result contents simpler.

Good idea!

@maxrjonesmaxrjones added the final review call This PR requires final review and approval from a second reviewer label Feb 14, 2022
@seismanseisman changed the title Use xarray.testing rather than pygmt.grdinfo in grdgradient testsChange test_grdgradient.py to use static_earth_reliefFeb 15, 2022
@seisman
seisman merged commit ac0b99e into mainFeb 15, 2022
@seisman
seisman deleted the remove-grdinfo/grdgradient branch February 15, 2022 08:08
@seismanseisman removed the final review call This PR requires final review and approval from a second reviewer label Feb 15, 2022
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

maintenanceBoring but important stuff for the core devsskip-changelogSkip adding Pull Request to changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@willschlitzer@maxrjones@seisman