Open rabernat opened 2 years ago
Thanks for the references! I've been picking this up as well in my review of https://github.com/google/xarray-beam/pull/31. This is indeed a happy coincidence.
From an information perspective, it seems like Index
keeps track of a little more information? We don't have an equivalent of sequence_len
in xarray_beam.Key
. I can see how that would be useful -- in Xarray-Beam, you have to supply dimension sizes explicitly in Rechunk
. On the other hand, maybe you don't need that information for many operations, so it could be annoying to need to update that.
Did you consider using a frozenset
instead of a tuple
for Index
?
At today's Pangeo Forge meeting, @alxmrs told us a bit more about Xarray Beam. I'm happy to note that we are aligning a bit around certain abstractions. I'm not proposing to merge or share code or anything at this stage. Just happy to see that we have independently arrived at some similar concepts. Comparing side by side may also suggest improvements.
Xarray Beam
https://xarray-beam.readthedocs.io/en/latest/data-model.html#keys-in-xarray-beam
Pangeo Forge
We currently call this an "index," although I agree that key is a better name. Our use of indexes is less well documented as it is not really public API but more of an internal thing. We mention it here: https://pangeo-forge.readthedocs.io/en/latest/recipe_user_guide/file_patterns.html#inspect-a-filepattern
The code is pretty straightforward and the comments explain things better.
https://github.com/pangeo-forge/pangeo-forge-recipes/blob/49997cb52cff466bd394c1348ef23981e782a4d9/pangeo_forge_recipes/patterns.py#L70-L114
These indexes are used both by FilePatterns (see #31) as well as for parallel writing of Zarr datasets.
cc @cisaacstern