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

Add (geo) data cube specification and cube generation guide to docs #844

Open
forman opened this issue Mar 30, 2023 · 0 comments
Open

Add (geo) data cube specification and cube generation guide to docs #844

forman opened this issue Mar 30, 2023 · 0 comments
Labels
doc Issue is related to documentation enhancement New feature or request

Comments

@forman
Copy link
Member

forman commented Mar 30, 2023

Is your feature request related to a problem? Please describe.

xcube has a quite clear idea of how a (geo) data cube should be represented using Zarr as external format and xarray.Dataset as in-memory representation.

Describe the solution you'd like

Provide a specification of the xcube (geo) data cube profile and provide a practical guide to generate cubes that conform to the specification. Add them as markdown files to xcube's docs folder.

The practical guide should include how-to's such as

  • how to encode datatype and set fill value (before using xarray and afterwards using "xcube patch")
  • how to encode grid mapping (before using xcube/xarray and afterwards using "xcube patch")
  • how to encode color mappings (before using xcube/xarray and afterwards using "xcube patch")
  • how to determine a variable's reasonable display ranges taking into account data distribution (linear, normal, log) and categorical data
  • how to fix issues with time dimension/coordinates
  • how to create pyramids
  • how to write cubes without fill value chunks

Additional context

@forman forman added enhancement New feature or request doc Issue is related to documentation labels Mar 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issue is related to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant