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.

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

Add load_earth_vertical_gravity_gradient function for Earth vertical gravity gradient dataset #2240

Merged
merged 16 commits into from
Dec 23, 2022

Conversation

willschlitzer
Copy link
Contributor

@willschlitzer willschlitzer commented Dec 9, 2022

This adds the load_earth_vertical_gravity_gradient function for the Earth vertical gravity gradient dataset.

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

@willschlitzer willschlitzer added the feature Brand new feature label Dec 9, 2022
@willschlitzer willschlitzer added this to the 0.8.0 milestone Dec 9, 2022
@willschlitzer willschlitzer self-assigned this Dec 9, 2022
@willschlitzer willschlitzer changed the title WIP: Add load_earth_vgg function for Earth vertical gravity gradient dataset Add load_earth_vgg function for Earth vertical gravity gradient dataset Dec 9, 2022
@willschlitzer willschlitzer marked this pull request as ready for review December 9, 2022 15:12
@@ -225,6 +225,7 @@ and store them in GMT's user data directory.
datasets.load_earth_geoid
datasets.load_earth_magnetic_anomaly
datasets.load_earth_relief
datasets.load_earth_vgg
Copy link
Member

Choose a reason for hiding this comment

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

Is earth_vgg a good name? Perhaps we should use earth_vertical_gravity_gradient instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I debated that, but my decision to use earth_vgg was that earth_vertical_gravity_gradient is super long to type out. My thought is that earth_vgg is unique enough as to not be confusing.

Copy link
Member

Choose a reason for hiding this comment

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

earth_vertical_gravity_gradient is super long to type out.

Yes, but we have autocompletion so a long name is still easy to type.

My thought is that earth_vgg is unique enough as to not be confusing.

earth_vgg is unique, but it doesn't tell users what the dataset is.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Changed to load_earth_vertical_gravity_gradient

@yvonnefroehlich yvonnefroehlich mentioned this pull request Dec 20, 2022
65 tasks
@willschlitzer willschlitzer changed the title Add load_earth_vgg function for Earth vertical gravity gradient dataset Add load_earth_vertical_gravity_gradient function for Earth vertical gravity gradient dataset Dec 20, 2022
@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label Dec 22, 2022
@seisman seisman merged commit 6083975 into main Dec 23, 2022
@seisman seisman deleted the load-remote-dataset/earth-vertical-gravity-gradient branch December 23, 2022 03:17
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Dec 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature Brand new feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants