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 information about pyramid structure and metadata schema #89

Merged
merged 6 commits into from
Jan 19, 2024

Conversation

maxrjones
Copy link
Contributor

Fixes #78, #88

@maxrjones
Copy link
Contributor Author

maxrjones commented Jan 19, 2024

@katamartin would you be willing to review https://ndpyramid--89.org.readthedocs.build/en/89/schema.html for accuracy, since it references a lot of @carbonplan/maps components?

Copy link
Member

@katamartin katamartin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks really great -- thank you for putting it together!! Left a few small comments, but generally looks good to me!

docs/schema.md Outdated Show resolved Hide resolved
docs/schema.md Outdated
}
```

If the `"crs"` attribute is not included, the pyramid levels are assumed to be in the Web Mercator projection.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@carbonplan/maps doesn't actually use crs currently, though it certainly could!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, good to know! Is this hard-coded in a maps deployment instead?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, both projection and Zarr version are currently configured via props passed to @carbonplan/maps components.


- Consistent chunk size across pyramid levels (128, 256, or 512 are recommended)
- [zlib](https://numcodecs.readthedocs.io/en/stable/zlib.html) or [gzip](https://numcodecs.readthedocs.io/en/stable/gzip.html) compression
- Web Mercator (EPSG:3857) or Equidistant Cylindrical (EPSG:4326) projection
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we add a bullet about the support dtypes? Confusingly, they vary slightly across Zarr v2 and Zarr v3.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point, thanks! Since V3 is experimental, I'll just reference the V2 dtypes

@maxrjones maxrjones merged commit af6f2fb into main Jan 19, 2024
10 checks passed
@maxrjones maxrjones deleted the schema-docs branch January 19, 2024 17:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

What standard do ndpyramids conform to?
2 participants