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

Document DataGranule "umm" and "meta" members #368

Open
MattF-NSIDC opened this issue Nov 27, 2023 · 4 comments
Open

Document DataGranule "umm" and "meta" members #368

MattF-NSIDC opened this issue Nov 27, 2023 · 4 comments
Labels
impact: documentation Improvements or additions to documentation

Comments

@MattF-NSIDC
Copy link

Follow-up from #367.

Granules have granule["umm"] and granule["meta"] members that are not currently documented. What's the best way to document this? Expose them in a way that our autodoc gets it? Or write a how-to? Both?

@MattF-NSIDC MattF-NSIDC added the impact: documentation Improvements or additions to documentation label Nov 27, 2023
@MattF-NSIDC MattF-NSIDC changed the title Document granule "umm" and "meta" members Document DataGranule "umm" and "meta" members Nov 27, 2023
@MattF-NSIDC MattF-NSIDC changed the title Document DataGranule "umm" and "meta" members Document DataGranule "umm" and "meta" members Nov 27, 2023
@andypbarrett
Copy link
Collaborator

The UMM and Metadata components are/should be documented elsewhere. If they are documented elsewhere, I don't think earthaccess needs to document what these metadata components are. Maybe just link to other online resources. However, we should expose/demonstrate how to access these.

Would something as simple as granules["umm"].keys() do the job. Along with dome common use cases such as the xml example here.

@mfisher87
Copy link
Collaborator

However, we should expose/demonstrate how to access these.

💯 Agreed we shouldn't document the structure of the data, just how to access the attributes from earthaccess!

@jessnicwelch
Copy link
Collaborator

However, we should expose/demonstrate how to access these.

💯 Agreed we shouldn't document the structure of the data, just how to access the attributes from earthaccess!

I also agree... better to maintain only one source. If you know already, could you say where these members are used in the earthaccess guide and a link to the source material?

@mfisher87
Copy link
Collaborator

I don't believe we have any documentation that references these attributes. Yet :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
impact: documentation Improvements or additions to documentation
Projects
Status: 🆕 New
Development

No branches or pull requests

4 participants