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 optional aliases field to JSON for a codec #279

Open
DennisHeimbigner opened this issue Jun 2, 2021 · 2 comments
Open

Add optional aliases field to JSON for a codec #279

DennisHeimbigner opened this issue Jun 2, 2021 · 2 comments

Comments

@DennisHeimbigner
Copy link

DennisHeimbigner commented Jun 2, 2021

I would like to propose a new, optional field to be added to the JSON codec format.
The field is called "aliases" and its value is a dictionary where the key provides information about the genesis of the alias and the value of the key is the alias itself.
The immediate goal is to allow the specification of HD5 filter ids in associate with a NumCodecs identifier. So for example, one might have this:

{
        "id": "bz2",
        "level": 1,
        "aliases": {"hdf5": "307", "NumCodecs": ["bzip2", "bzip"]}
}

This indicate that the NumCodecs "bz2" filter is the same as the HDF5 filter with assigned id 307. It also indicates that the NumCodec IDS "bzip2" and "bzip" should be considered aliases for "bz2"

Semantically, since it is optional, any implementation is free to ignore the "aliases" field and is also free to ignore any entries in its associated aliases dictionary.

@DennisHeimbigner
Copy link
Author

Withdrawn for further consideration.

@DennisHeimbigner
Copy link
Author

Re-opened with an extended example.

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

No branches or pull requests

1 participant