Add earth_relief_holes to load_sample_data()

[willschlitzer]

This adds a function to load the remote dataset @earth_relief_20m_holes.grd for use with the in-line example for grdfill.

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

[weiji14]

Thanks @willschlitzer! Do you also want to add @earth_relief_20m_holes to the cache list at

pygmt/pygmt/helpers/testing.py

Lines 153 to 155 in 951d30a

	# List of datasets to download
	datasets = [
	# Earth relief grids

?

[seisman]

Pylint reports the following warning.

pygmt/datasets/samples.py:351:0: W0613: Unused argument 'kwargs' (unused-argument)

I think we don't need kwagrs for new datasets.

Suggested change

	def _load_earth_relief_holes(**kwargs):
	def _load_earth_relief_holes():

[willschlitzer]

I'll check again to confirm after I rewrite the tests, but I think it needs **kwargs because of data = load_func[name](suppress_warning=True). It was getting passed a value for suppress_warning but wasn't expecting any arguments.

[willschlitzer]

I received TypeError: _load_earth_relief_holes() got an unexpected keyword argument 'suppress_warning' when I tried running it without **kwargs.

[seisman]

The suppress_warning parameter (or **kwargs) was added so that users who call the deprecated, old load_xxx functions can silent the deprecation warnings by passing suppress_warning=True. Thus, **kwargs is NOT required for new private _load_xxx functions.

Do you think we should rewrite the code to call the old and new load_xxx functions in different ways:

    # old public load functions for backward compatibility
    load_func_old = {
        "bathymetry": load_sample_bathymetry,
        "fractures": load_fractures_compilation,
        "hotspots": load_hotspots,
        "japan_quakes": load_japan_quakes,
        "mars_shape": load_mars_shape,
        "ocean_ridge_points": load_ocean_ridge_points,
        "usgs_quakes": load_usgs_quakes,
    }
    # new private load functions
    load_func = {
        "earth_relief_holes": _load_earth_relief_holes,
    }
    if name in load_func_old:
        data = load_func[name](suppress_warning=True)
    else:
        data = load_func[name]
    return data

[willschlitzer]

I think that's a good idea. I think this should be a separate PR; does that work? I'm happy to do it (admittedly copying the code above) but won't be able to get to it until tomorrow.

[seisman]

A separate PR is OK to me.

[willschlitzer]

@GenericMappingTools/pygmt-admin It looks like this is failing some tests because of the change to gridline registration for @earth_relief_20m_holes.grd. Is this file now stable?

[seisman]

@GenericMappingTools/pygmt-admin It looks like this is failing some tests because of the change to gridline registration for @earth_relief_20m_holes.grd. Is this file now stable?

xref: the grid file registration was changed in GenericMappingTools/gmtserver-admin#156

[maxrjones]

@GenericMappingTools/pygmt-admin It looks like this is failing some tests because of the change to gridline registration for @earth_relief_20m_holes.grd. Is this file now stable?

Yes, it's now stable so the baseline images can be updated.