Add function to import hotspot dataset

[willschlitzer]

This pull request adds a function to import the hotspots.txt dataset used in some of the GMT code examples. Unfortunately, due to inconsistent spacing between the columns in the data, I was not able to use pd.read_csv() to read the data into a DataFrame. It would be great to get any feedback to shorten this code, as it currently appears messy.

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

[willschlitzer]

@GenericMappingTools/pygmt-maintainers Any ideas on how to make this csv import look less hacked together?

[weiji14]

@GenericMappingTools/pygmt-maintainers Any ideas on how to make this csv import look less hacked together?

Have you tried using sep='\s+' in pd.read_csv()?

[willschlitzer]

@GenericMappingTools/pygmt-maintainers Any ideas on how to make this csv import look less hacked together?

Have you tried using sep='\s+' in pd.read_csv()?

I have. The problem is that I want to include the entire hotspot name in one field/string, but they're inconsistent in spacing/number of words. For example, the Bermuda line reads BERMUDA NaN NaN while three word ones read like LAKE VICTORIA, EAST when I set sep='\s+.

[weiji14]

Sorry for the delay. I see what you mean by inconsistent spacing, the hotspots.txt file is space-separated for the first three columns and tab-separated for the last column. I've figured out one alternative way by reading in the first 3 and last 1 column separately, and then concatenating together (see below).

P.S. There are some commits in this PR on sphdistance. You might want to cherry-pick the 'hotspot' only commits to a clean 'add-hospot-dataset' branch (and do a force-push). Or we could merge in the sphdistance PR at #1383 before this #1386 PR to save you some hassle 🙂

[willschlitzer]

@meghanrjones It looks like your PR has been merged; am I cleared to update the pd.read_csv() call?

There are some technical problems on the GMT server, so the hotspots.txt is still not updated on the server.

Sounds good; I'll wait until the remote file is updated and then push an update to this PR. I'll convert to draft for the time being.

[seisman]

@willschlitzer The hotspots.txt file is now updated.

[willschlitzer]

@willschlitzer The hotspots.txt file is now updated.

Sounds good, I'll update this branch and make sure everything checks out.

[willschlitzer]

@GenericMappingTools/pygmt-maintainers I have updated load_hotspots() for the new format of hotspots.txt.

[maxrjones]

Nice work! Just one final recommendation to add the reference for the original data.