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

Improve the description of usage of remote datasets #2347

Open
seisman opened this issue Feb 2, 2023 · 0 comments
Open

Improve the description of usage of remote datasets #2347

seisman opened this issue Feb 2, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation help wanted Helping hands are appreciated
Milestone

Comments

@seisman
Copy link
Member

seisman commented Feb 2, 2023

Take the earth_age dataset as an example. Currently, the documentation says:

These grids can also be accessed by passing in the file name @earth_age_res[_reg] to any grid plotting/processing function. res is the grid resolution (see below), and reg is grid registration type (p for pixel registration or g for gridline registration).

There are some issues with the description:

  1. People may have no idea that [] means _reg is optional.
  2. Since GMT 6.3.0 (see Implement auto resolution for remote grids for plotting modules gmt#5753), GMT can automatically determine the suitable grid resolution based on the -R and -J settings. Thus _res is also optional.

Here is a working example showing how the automatic grid resolution works for remote datasets:

import pygmt

fig = pygmt.Figure()
fig.basemap(region="g", frame=True, projection="H10c")
fig.grdimage(grid="@earth_relief")
fig.show()

We need to improve the documentation to clarify these two points.

@seisman seisman added documentation Improvements or additions to documentation help wanted Helping hands are appreciated labels Feb 2, 2023
@seisman seisman added this to the 0.9.0 milestone Feb 2, 2023
@seisman seisman modified the milestones: 0.9.0, 0.10.0 Mar 19, 2023
@weiji14 weiji14 removed this from the 0.10.0 milestone Aug 24, 2023
@seisman seisman added this to the 0.13.0 milestone May 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Helping hands are appreciated
Projects
None yet
Development

No branches or pull requests

2 participants