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

Example datatree for use in tutorial documentation #9437

Open
6 tasks
eni-awowale opened this issue Sep 7, 2024 · 0 comments
Open
6 tasks

Example datatree for use in tutorial documentation #9437

eni-awowale opened this issue Sep 7, 2024 · 0 comments
Labels
topic-DataTree Related to the implementation of a DataTree class topic-documentation

Comments

@eni-awowale
Copy link
Collaborator

What is your issue?

Copied from xarray-contrib/datatree#100 additional comments are there.

Example datatree for use in tutorial documentation

What would help me enormously with writing documentation would be a killer example datatree, which I could open and use to demonstrate use of all types of methods. Just like we have the "air_temperature" example dataset used in the main xarray documentation.

To be as useful as possible, this example tree should hit a few criteria:

  • Nested - there needs to be some reason why you wouldn't just use a Dataset to organise this data. Multiple resolutions is a simple reason, but it also should be >1 level deep.
  • Common coordinates - it should have a least one common coordinate stored closer to the root of the tree. For example a reference normalisation value of some quantity, or perhaps some grid-related information that applies to the data in multiple sub-groups.
  • Heterogenous data - there is no restriction on the relationship between data in different nodes, so we should demonstrate this by storing data that is as different as possible (but still somehow related). I'm thinking maybe some demographic data vs geographical, or model data vs observational.
  • Small - though we would download this with pooch instead of uploading the data files in the repo, we still want this to be small enough that we don't cause problems when building or viewing our docs.
  • Multidimensional - the data stored in the leaves needs to have enough dimensions so that I can reduce/aggregate it and still have something interesting left to plot.
  • Recognisable - Ideally it would contain some relatable data. The existing Dataset example is nice because you can immediately see you are looking at a (low-resolution) map of North America. Maybe a satellite image of Manhattan Island or something?

A really good inspiration is this pseudo-structure provided in #4118:

image

This would hit all of the criteria above, if it actually existed somewhere I could find!

What I would like is for people who have more familiarity with real geo-science data products to help me make this killer example tree, or at least point me towards data that I might use.

If we have multiple good suggestions I could make multiple different examples to use, but I think I would prefer one really good one to multiple quite good ones. Alternatively any extras could end up getting used for some future example notebooks though.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic-DataTree Related to the implementation of a DataTree class topic-documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant