-
Notifications
You must be signed in to change notification settings - Fork 10
adds extensions that zarr-python defines #1
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
Merged
Merged
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# Vlen-bytes codec | ||
|
||
Defines an `array -> bytes` codec that serializes variable-length byte string arrays. | ||
|
||
## Codec name | ||
|
||
The value of the `name` member in the codec object MUST be `vlen-bytes`. | ||
|
||
## Configuration parameters | ||
|
||
None. | ||
|
||
## Example | ||
|
||
For example, the array metadata below specifies that the array contains variable-length byte strings: | ||
|
||
```json | ||
{ | ||
"data_type": "bytes", | ||
"codecs": [{ | ||
"name": "vlen-bytes" | ||
}], | ||
} | ||
``` | ||
|
||
## Format and algorithm | ||
|
||
This is a `array -> bytes` codec. | ||
|
||
This codec is only compatible with the [`"bytes"`](../../data-types/bytes/README.md) data type. | ||
|
||
See https://numcodecs.readthedocs.io/en/stable/other/vlen.html#vlenbytes for details about the encoding. | ||
|
||
## Change log | ||
|
||
No changes yet. | ||
|
||
## Current maintainers | ||
|
||
* [zarr-python core development team](https://github.com/orgs/zarr-developers/teams/python-core-devs) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
{ | ||
"$schema": "https://json-schema.org/draft/2020-12/schema", | ||
"anyOf": [ | ||
{ | ||
"type": "object", | ||
"properties": { | ||
"name": { | ||
"type": "string", | ||
"enum": ["vlen-bytes"] | ||
}, | ||
"configuration": { | ||
"type": "object", | ||
"additionalProperties": false | ||
} | ||
}, | ||
"required": ["name"], | ||
"additionalProperties": false | ||
}, | ||
{ "type": "string", "enum": ["vlen-bytes"] } | ||
] | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# Vlen-utf8 codec | ||
|
||
Defines an `array -> bytes` codec that serializes variable-length UTF8 string arrays. | ||
|
||
## Codec name | ||
|
||
The value of the `name` member in the codec object MUST be `vlen-utf8`. | ||
|
||
## Configuration parameters | ||
|
||
None. | ||
|
||
## Example | ||
|
||
For example, the array metadata below specifies that the array contains variable-length UTF8 strings: | ||
|
||
```json | ||
{ | ||
"data_type": "string", | ||
"codecs": [{ | ||
"name": "vlen-utf8" | ||
}], | ||
} | ||
``` | ||
|
||
## Format and algorithm | ||
|
||
This is a `array -> bytes` codec. | ||
|
||
This codec is only compatible with the [`"string"`](../../data-types/string/README.md) data type. | ||
|
||
See https://numcodecs.readthedocs.io/en/stable/other/vlen.html#vlenutf8 for details about the encoding. | ||
|
||
## Change log | ||
|
||
No changes yet. | ||
|
||
## Current maintainers | ||
|
||
* [zarr-python core development team](https://github.com/orgs/zarr-developers/teams/python-core-devs) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
{ | ||
"$schema": "https://json-schema.org/draft/2020-12/schema", | ||
"anyOf": [ | ||
{ | ||
"type": "object", | ||
"properties": { | ||
"name": { | ||
"type": "string", | ||
"enum": ["vlen-utf8"] | ||
}, | ||
"configuration": { | ||
"type": "object", | ||
"additionalProperties": false | ||
} | ||
}, | ||
"required": ["name"], | ||
"additionalProperties": false | ||
}, | ||
{ "type": "string", "enum": ["vlen-utf8"] } | ||
] | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# Bytes data type | ||
|
||
Defines a data type for variable-length byte strings. | ||
|
||
## Permitted fill values | ||
|
||
The value of the `fill_value` metadata key must be an array of byte values. | ||
|
||
## Example | ||
|
||
For example, the array metadata below specifies that the array contains variable-length byte strings: | ||
|
||
```json | ||
{ | ||
"data_type": "bytes", | ||
"fill_value": [1, 2, 3], | ||
"codecs": [{ | ||
"name": "vlen-bytes" | ||
}], | ||
} | ||
``` | ||
|
||
## Notes | ||
|
||
Currently, this data type is only compatible with the [`"vlen-bytes"`](../../codecs/vlen-bytes/README.md) codec. | ||
|
||
## Change log | ||
|
||
No changes yet. | ||
|
||
## Current maintainers | ||
|
||
* [zarr-python core development team](https://github.com/orgs/zarr-developers/teams/python-core-devs) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
{ | ||
"$schema": "https://json-schema.org/draft/2020-12/schema", | ||
"anyOf": [ | ||
{ | ||
"type": "object", | ||
"properties": { | ||
"name": { | ||
"type": "string", | ||
"enum": ["bytes"] | ||
}, | ||
"configuration": { | ||
"type": "object", | ||
"additionalProperties": false | ||
} | ||
}, | ||
"required": ["name"], | ||
"additionalProperties": false | ||
}, | ||
{ "type": "string", "enum": ["bytes"] } | ||
] | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# String data type | ||
|
||
Defines a data type for variable-length UTF8 strings. | ||
|
||
## Permitted fill values | ||
|
||
The value of the `fill_value` metadata key must be unicode string. | ||
|
||
## Example | ||
|
||
For example, the array metadata below specifies that the array contains variable-length byte strings: | ||
|
||
```json | ||
{ | ||
"data_type": "string", | ||
"fill_value": "foo", | ||
"codecs": [{ | ||
"name": "vlen-utf8" | ||
}], | ||
} | ||
``` | ||
|
||
## Notes | ||
|
||
Currently, this data type is only compatible with the [`"vlen-utf8"`](../../codecs/vlen-utf8/README.md) codec. | ||
|
||
## Change log | ||
|
||
No changes yet. | ||
|
||
## Current maintainers | ||
|
||
* [zarr-python core development team](https://github.com/orgs/zarr-developers/teams/python-core-devs) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
{ | ||
"$schema": "https://json-schema.org/draft/2020-12/schema", | ||
"anyOf": [ | ||
{ | ||
"type": "object", | ||
"properties": { | ||
"name": { | ||
"type": "string", | ||
"enum": ["string"] | ||
}, | ||
"configuration": { | ||
"type": "object", | ||
"additionalProperties": false | ||
} | ||
}, | ||
"required": ["name"], | ||
"additionalProperties": false | ||
}, | ||
{ "type": "string", "enum": ["string"] } | ||
] | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.