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

is there a detailed user manual? #240

Closed
lwk1542 opened this issue May 11, 2023 · 4 comments
Closed

is there a detailed user manual? #240

lwk1542 opened this issue May 11, 2023 · 4 comments
Labels
feedback requested We requested feedback from the reporter; if we don't hear back in X days the issue may be closed

Comments

@lwk1542
Copy link

lwk1542 commented May 11, 2023

such as:

  1. how to set the configuration content of .netrc file. EARTHDATA_USERNAME=[],EARTHDATA_PASSWORD=[]
  2. What are the optional parameters for variables? I want to search MOD021KM, how to set the short_name or sensor?
  3. ...
@jroebuck932
Copy link
Collaborator

Hi, thank you for your question. We are currently working on detailed user documentation and we can let you know as soon as that is available. In the meantime, I can try to answer your two questions:

  1. For details on how to configure the netrc with your earthdata login details, please see Step 1 at the top of this help article: https://nsidc.org/data/user-resources/help-center/programmatic-data-access-guide

  2. To search for MOD021KM, you could use the search_data method:

results = earthaccess.search_data(
    short_name = 'MOD021KM',
    cloud_hosted = False,
    bounding_box = (-180,-90,180,90)
    temporal = ('2022-01-01,2022-01-31)
    count = 100
)

where
cloud_hosted = False will search for data that are not in the cloud
bounding_box is a spatial filter by specifying the latitude and longitude in the order of W,S,E,N
temporal is a temporal filter by specifying a start and end date in the format YYYY-MM-DD
count sets the maximum number of granules that will be returned in the search

I hope this helps

@asteiker asteiker added the feedback requested We requested feedback from the reporter; if we don't hear back in X days the issue may be closed label Oct 29, 2024
Copy link

Closing after 10 days of waiting for feedback. If you feel this was in error, please re-open, @ a maintainer, or create new issues.

@asteiker
Copy link
Member

@lwk1542 For 1., we have documentation on .netrc usage here: https://earthaccess.readthedocs.io/en/latest/howto/authenticate/#authentication. For 2., We have a list of arguments for data search here: https://earthaccess.readthedocs.io/en/latest/user-reference/api/api/#earthaccess.api.search_data.

Thank you @jroebuck932 for your earlier suggestions! We miss you at NSIDC ❤️

@mfisher87
Copy link
Collaborator

2., We have a list of arguments for data search here: https://earthaccess.readthedocs.io/en/latest/user-reference/api/api/#earthaccess.api.search_data.

Although those lists are incomplete at the moment! See: #345

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feedback requested We requested feedback from the reporter; if we don't hear back in X days the issue may be closed
Projects
Status: Done
Development

No branches or pull requests

4 participants