-
Notifications
You must be signed in to change notification settings - Fork 224
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
Remote datasets: Add "uncertainty" parameter to "load_earth_free_air_anomaly" to load the "free-air anomaly uncertainty" dataset #3727
Conversation
This reverts commit 0a96819.
@@ -20,36 +21,42 @@ def load_earth_free_air_anomaly( | |||
] = "01d", | |||
region: Sequence[float] | str | None = None, | |||
registration: Literal["gridline", "pixel", None] = None, | |||
data_source: Literal["faa", "faaerror"] = "faa", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't like the parameter name data_source
here, since these two datasets acutally comes from the same source.
Maybe uncertainty=True
to use the faaerror
data?
Co-authored-by: Dongdong Tian <[email protected]>
Co-authored-by: Dongdong Tian <[email protected]>
Co-authored-by: Dongdong Tian <[email protected]>
Co-authored-by: Dongdong Tian <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me except minor suggestion on docstrings.
|
||
IGPP Earth free-air anomaly dataset. | ||
* - IGPP Earth Free-Air Anomaly | ||
- IGPP Earth Free-Air Anomaly Errors |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- IGPP Earth Free-Air Anomaly Errors | |
- IGPP Earth Free-Air Anomaly Uncertainty |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hm. I used the name for the upstream docs at https://www.generic-mapping-tools.org/remote-datasets/earth-faaerror.html. But I was wondering, if "uncertainty" is better, as it is used in the docstrings. Maybe we should also update the upstream docs; I can include this in PR GenericMappingTools/remote-datasets#128 if approved.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The GMT remote-dataset docs is inconsistenly using "error" and "uncertainty", while the officiail README file (https://topex.ucsd.edu/pub/global_grav_1min/README_V32.txt) uses "uncertainty":
grav_error_32.1.nc - uncertainty in gravity anomaly and sea surface slope, milligal or microradian, netcdf, lon-lat coordinates
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Made commit GenericMappingTools/remote-datasets@5aa5e58 for changing this in the GMT remote-dataset docs.
But we stick to "error" in the GMT dataset name faaerror
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think faaerror is fine.
BTW, maybe change the PR title to "load_earth_free_air_anomaly: Add the 'uncertainty' parameter to return free-air anomaly errors". |
Co-authored-by: Dongdong Tian <[email protected]>
Co-authored-by: Dongdong Tian <[email protected]>
Co-authored-by: Dongdong Tian <[email protected]>
Description of proposed changes
Add the parameter
uncertainty
to the functionload_earth_free_air_anomaly
to load the dataset "IGPP Earth Free-Air Anomaly Uncertainty"Adresses #2431
Preview: https://pygmt-dev--3727.org.readthedocs.build/en/3727/api/generated/pygmt.datasets.load_earth_free_air_anomaly.html
Reminders
make format
andmake check
to make sure the code follows the style guide.doc/api/index.rst
.Slash Commands
You can write slash commands (
/command
) in the first line of a comment to performspecific operations. Supported slash command is:
/format
: automatically format and lint the code