Expand table-like input options for sphdistance

[willschlitzer]

This pull request adds data to the parameter list in the docstring and moves the sphdistance function to the tabular data section in the index.

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 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]

Could you also:

• Rename table to data at L25, L61, and also in pygmt/tests/test_sphdistance.py
• At L52: Insert blank line between:

       Return type depends on whether the ``outgrid`` parameter is set:
        - :class:`xarray.DataArray` if ``outgrid`` is not set

to prevent a Sphinx warning pygmt/pygmt/src/sphdistance.py:docstring of pygmt.src.sphdistance.sphdistance:67: WARNING: Unexpected indentation

[seisman]

Do you want to add "xyz" input support (like #1531) in this PR or a separate PR?

[willschlitzer]

Do you want to add "xyz" input support (like #1531) in this PR or a separate PR?

I can give it a try.

[willschlitzer]

@seisman Doesn't sphdistance only require lat-long inputs? I don't think there should be z inputs.

[seisman]

@seisman Doesn't sphdistance only require lat-long inputs? I don't think there should be z inputs.

I've never used sphdistance, but reading the sphdistance manpage, I think only x and y are required.

[willschlitzer]

@seisman Doesn't sphdistance only require lat-long inputs? I don't think there should be z inputs.

I've never used sphdistance, but reading the sphdistance manpage, I think only x and y are required.

So should I then remove z from the parameters? I'm getting this error when I run the tests: pygmt.exceptions.GMTInvalidInput: data must provide x, y, and z columns

[seisman]

@seisman Doesn't sphdistance only require lat-long inputs? I don't think there should be z inputs.

I've never used sphdistance, but reading the sphdistance manpage, I think only x and y are required.

So should I then remove z from the parameters? I'm getting this error when I run the tests: pygmt.exceptions.GMTInvalidInput: data must provide x, y, and z columns

Yes, please. Sorry for misleading you.

[weiji14]

The docstring description reads: sphdistance reads one or more ASCII [or binary] files (or standard input), but 'standard input' (stdin) doesn't make sense in the Python world, suggest rewording it to use just 'table', similar to #1418 (comment).

[weiji14]

Typo here. Also, just noticed that this summary doesn't seem correct. It seems to suggest Voronoi polygons are created, but the output is a raster grid, not a vector polygon. Maybe follow https://docs.generic-mapping-tools.org/6.2/sphdistance.html.

Suggested change

	Create Voroni polygons from lat/lon coordinates.
	Create Voronoi polygons from lat/lon coordinates.

[seisman]

@willschlitzer The tests fail because the Windows server cannot download the cache file EGM96_to_36.txt, which was added in #1434, but not cached.

Please trigger the cache_data.yml workflow manually to update the caches.

[willschlitzer]

Please trigger the cache_data.yml workflow manually to update the caches.

@seisman How do I do this?

[seisman]

Please trigger the cache_data.yml workflow manually to update the caches.

@seisman How do I do this?

You need to uncomment the following line (removing the leading #), commit the changes, and wait for the finish of the workflow. After that, you need to revert that commit:

pygmt/.github/workflows/cache_data.yaml

Line 6 in 0926206

# pull_request: