hdf5-as-virtual-zarr 0.1.0 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +25 -1
- package/dist/bundled/index.js +3338 -0
- package/dist/bundled/index.js.map +1 -0
- package/dist/encoding.d.ts +21 -0
- package/dist/encoding.js +62 -0
- package/dist/hdf-store.d.ts +21 -4
- package/dist/hdf-store.js +23 -3
- package/dist/index.d.ts +2 -1
- package/dist/index.js +2 -1
- package/dist/jsfive/dataobjects.js +14 -0
- package/dist/jsfive/datatype-msg.d.ts +1 -0
- package/dist/jsfive/datatype-msg.js +58 -1
- package/dist/ref-spec-to-consolidated-metadata.d.ts +19 -0
- package/dist/ref-spec-to-consolidated-metadata.js +25 -0
- package/dist/ref-spec-v2-to-v3.d.ts +13 -0
- package/dist/ref-spec-v2-to-v3.js +177 -0
- package/dist/ref-store.d.ts +3 -3
- package/dist/ref-store.js +5 -2
- package/dist/single-hdf5-to-zarr.d.ts +6 -0
- package/dist/single-hdf5-to-zarr.js +68 -41
- package/dist/types.d.ts +5 -1
- package/package.json +12 -7
- package/src/encoding.ts +64 -0
- package/src/hdf-store.ts +30 -6
- package/src/index.ts +2 -1
- package/src/jsfive/dataobjects.ts +12 -0
- package/src/jsfive/datatype-msg.ts +67 -1
- package/src/ref-spec-to-consolidated-metadata.ts +45 -0
- package/src/ref-spec-v2-to-v3.ts +199 -0
- package/src/ref-store.ts +8 -5
- package/src/single-hdf5-to-zarr.ts +60 -47
- package/src/types.ts +6 -1
- package/test/fixtures/dense.adata.zarr/.zattrs +0 -4
- package/test/fixtures/dense.adata.zarr/.zgroup +0 -3
- package/test/fixtures/dense.adata.zarr/.zmetadata +0 -285
- package/test/fixtures/dense.adata.zarr/X/.zarray +0 -22
- package/test/fixtures/dense.adata.zarr/X/.zattrs +0 -4
- package/test/fixtures/dense.adata.zarr/X/0.0 +0 -0
- package/test/fixtures/dense.adata.zarr/layers/.zattrs +0 -4
- package/test/fixtures/dense.adata.zarr/layers/.zgroup +0 -3
- package/test/fixtures/dense.adata.zarr/obs/.zattrs +0 -9
- package/test/fixtures/dense.adata.zarr/obs/.zgroup +0 -3
- package/test/fixtures/dense.adata.zarr/obs/_index/.zarray +0 -24
- package/test/fixtures/dense.adata.zarr/obs/_index/.zattrs +0 -4
- package/test/fixtures/dense.adata.zarr/obs/_index/0 +0 -0
- package/test/fixtures/dense.adata.zarr/obs/categorical/.zattrs +0 -5
- package/test/fixtures/dense.adata.zarr/obs/categorical/.zgroup +0 -3
- package/test/fixtures/dense.adata.zarr/obs/categorical/categories/.zarray +0 -24
- package/test/fixtures/dense.adata.zarr/obs/categorical/categories/.zattrs +0 -4
- package/test/fixtures/dense.adata.zarr/obs/categorical/categories/0 +0 -0
- package/test/fixtures/dense.adata.zarr/obs/categorical/codes/.zarray +0 -20
- package/test/fixtures/dense.adata.zarr/obs/categorical/codes/.zattrs +0 -4
- package/test/fixtures/dense.adata.zarr/obs/categorical/codes/0 +0 -0
- package/test/fixtures/dense.adata.zarr/obs/string/.zarray +0 -24
- package/test/fixtures/dense.adata.zarr/obs/string/.zattrs +0 -4
- package/test/fixtures/dense.adata.zarr/obs/string/0 +0 -0
- package/test/fixtures/dense.adata.zarr/obsm/.zattrs +0 -4
- package/test/fixtures/dense.adata.zarr/obsm/.zgroup +0 -3
- package/test/fixtures/dense.adata.zarr/obsm/X_umap/.zarray +0 -22
- package/test/fixtures/dense.adata.zarr/obsm/X_umap/.zattrs +0 -4
- package/test/fixtures/dense.adata.zarr/obsm/X_umap/0.0 +0 -0
- package/test/fixtures/dense.adata.zarr/obsp/.zattrs +0 -4
- package/test/fixtures/dense.adata.zarr/obsp/.zgroup +0 -3
- package/test/fixtures/dense.adata.zarr/raw/.zarray +0 -10
- package/test/fixtures/dense.adata.zarr/raw/.zattrs +0 -4
- package/test/fixtures/dense.adata.zarr/raw/0 +0 -0
- package/test/fixtures/dense.adata.zarr/uns/.zattrs +0 -4
- package/test/fixtures/dense.adata.zarr/uns/.zgroup +0 -3
- package/test/fixtures/dense.adata.zarr/var/.zattrs +0 -6
- package/test/fixtures/dense.adata.zarr/var/.zgroup +0 -3
- package/test/fixtures/dense.adata.zarr/var/_index/.zarray +0 -24
- package/test/fixtures/dense.adata.zarr/var/_index/.zattrs +0 -4
- package/test/fixtures/dense.adata.zarr/var/_index/0 +0 -0
- package/test/fixtures/dense.adata.zarr/varm/.zattrs +0 -4
- package/test/fixtures/dense.adata.zarr/varm/.zgroup +0 -3
- package/test/fixtures/dense.adata.zarr/varp/.zattrs +0 -4
- package/test/fixtures/dense.adata.zarr/varp/.zgroup +0 -3
- package/test/fixtures/dense.adata.zarr.json +0 -182
- package/test/fixtures/dense.adata.zmetadata.json +0 -1
- package/test/fixtures/dense.h5ad +0 -0
- package/test/fixtures/dense.h5ad.refspec.json +0 -1
- package/test/fixtures/dense.v3.adata.zarr/X/c/0/0 +0 -0
- package/test/fixtures/dense.v3.adata.zarr/X/zarr.json +0 -45
- package/test/fixtures/dense.v3.adata.zarr/layers/zarr.json +0 -8
- package/test/fixtures/dense.v3.adata.zarr/obs/_index/c/0 +0 -0
- package/test/fixtures/dense.v3.adata.zarr/obs/_index/zarr.json +0 -41
- package/test/fixtures/dense.v3.adata.zarr/obs/categorical/categories/c/0 +0 -0
- package/test/fixtures/dense.v3.adata.zarr/obs/categorical/categories/zarr.json +0 -41
- package/test/fixtures/dense.v3.adata.zarr/obs/categorical/codes/c/0 +0 -0
- package/test/fixtures/dense.v3.adata.zarr/obs/categorical/codes/zarr.json +0 -40
- package/test/fixtures/dense.v3.adata.zarr/obs/categorical/zarr.json +0 -9
- package/test/fixtures/dense.v3.adata.zarr/obs/string/c/0 +0 -0
- package/test/fixtures/dense.v3.adata.zarr/obs/string/zarr.json +0 -41
- package/test/fixtures/dense.v3.adata.zarr/obs/zarr.json +0 -13
- package/test/fixtures/dense.v3.adata.zarr/obsm/X_umap/c/0/0 +0 -0
- package/test/fixtures/dense.v3.adata.zarr/obsm/X_umap/zarr.json +0 -45
- package/test/fixtures/dense.v3.adata.zarr/obsm/zarr.json +0 -8
- package/test/fixtures/dense.v3.adata.zarr/obsp/zarr.json +0 -8
- package/test/fixtures/dense.v3.adata.zarr/raw/zarr.json +0 -36
- package/test/fixtures/dense.v3.adata.zarr/uns/zarr.json +0 -8
- package/test/fixtures/dense.v3.adata.zarr/var/_index/c/0 +0 -0
- package/test/fixtures/dense.v3.adata.zarr/var/_index/zarr.json +0 -41
- package/test/fixtures/dense.v3.adata.zarr/var/zarr.json +0 -10
- package/test/fixtures/dense.v3.adata.zarr/varm/zarr.json +0 -8
- package/test/fixtures/dense.v3.adata.zarr/varp/zarr.json +0 -8
- package/test/fixtures/dense.v3.adata.zarr/zarr.json +0 -469
- package/test/fixtures/dense.v3.adata.zarr.json +0 -102
- package/test/fixtures/generate_fixtures.py +0 -157
- package/test/fixtures/generate_fixtures_v3.py +0 -126
- package/test/fixtures/minimal.adata.zarr/.zattrs +0 -4
- package/test/fixtures/minimal.adata.zarr/.zgroup +0 -3
- package/test/fixtures/minimal.adata.zarr/.zmetadata +0 -168
- package/test/fixtures/minimal.adata.zarr/X/.zarray +0 -22
- package/test/fixtures/minimal.adata.zarr/X/.zattrs +0 -4
- package/test/fixtures/minimal.adata.zarr/X/0.0 +0 -0
- package/test/fixtures/minimal.adata.zarr/layers/.zattrs +0 -4
- package/test/fixtures/minimal.adata.zarr/layers/.zgroup +0 -3
- package/test/fixtures/minimal.adata.zarr/obs/.zattrs +0 -6
- package/test/fixtures/minimal.adata.zarr/obs/.zgroup +0 -3
- package/test/fixtures/minimal.adata.zarr/obs/_index/.zarray +0 -24
- package/test/fixtures/minimal.adata.zarr/obs/_index/.zattrs +0 -4
- package/test/fixtures/minimal.adata.zarr/obs/_index/0 +0 -0
- package/test/fixtures/minimal.adata.zarr/obsm/.zattrs +0 -4
- package/test/fixtures/minimal.adata.zarr/obsm/.zgroup +0 -3
- package/test/fixtures/minimal.adata.zarr/obsp/.zattrs +0 -4
- package/test/fixtures/minimal.adata.zarr/obsp/.zgroup +0 -3
- package/test/fixtures/minimal.adata.zarr/raw/.zarray +0 -10
- package/test/fixtures/minimal.adata.zarr/raw/.zattrs +0 -4
- package/test/fixtures/minimal.adata.zarr/raw/0 +0 -0
- package/test/fixtures/minimal.adata.zarr/uns/.zattrs +0 -4
- package/test/fixtures/minimal.adata.zarr/uns/.zgroup +0 -3
- package/test/fixtures/minimal.adata.zarr/var/.zattrs +0 -6
- package/test/fixtures/minimal.adata.zarr/var/.zgroup +0 -3
- package/test/fixtures/minimal.adata.zarr/var/_index/.zarray +0 -24
- package/test/fixtures/minimal.adata.zarr/var/_index/.zattrs +0 -4
- package/test/fixtures/minimal.adata.zarr/var/_index/0 +0 -0
- package/test/fixtures/minimal.adata.zarr/varm/.zattrs +0 -4
- package/test/fixtures/minimal.adata.zarr/varm/.zgroup +0 -3
- package/test/fixtures/minimal.adata.zarr/varp/.zattrs +0 -4
- package/test/fixtures/minimal.adata.zarr/varp/.zgroup +0 -3
- package/test/fixtures/minimal.adata.zarr.json +0 -126
- package/test/fixtures/minimal.adata.zmetadata.json +0 -1
- package/test/fixtures/minimal.h5ad +0 -0
- package/test/fixtures/minimal.h5ad.refspec.json +0 -1
- package/test/fixtures/minimal.v3.adata.zarr/X/c/0/0 +0 -0
- package/test/fixtures/minimal.v3.adata.zarr/X/zarr.json +0 -45
- package/test/fixtures/minimal.v3.adata.zarr/layers/zarr.json +0 -8
- package/test/fixtures/minimal.v3.adata.zarr/obs/_index/c/0 +0 -0
- package/test/fixtures/minimal.v3.adata.zarr/obs/_index/zarr.json +0 -41
- package/test/fixtures/minimal.v3.adata.zarr/obs/zarr.json +0 -10
- package/test/fixtures/minimal.v3.adata.zarr/obsm/zarr.json +0 -8
- package/test/fixtures/minimal.v3.adata.zarr/obsp/zarr.json +0 -8
- package/test/fixtures/minimal.v3.adata.zarr/raw/zarr.json +0 -36
- package/test/fixtures/minimal.v3.adata.zarr/uns/zarr.json +0 -8
- package/test/fixtures/minimal.v3.adata.zarr/var/_index/c/0 +0 -0
- package/test/fixtures/minimal.v3.adata.zarr/var/_index/zarr.json +0 -41
- package/test/fixtures/minimal.v3.adata.zarr/var/zarr.json +0 -10
- package/test/fixtures/minimal.v3.adata.zarr/varm/zarr.json +0 -8
- package/test/fixtures/minimal.v3.adata.zarr/varp/zarr.json +0 -8
- package/test/fixtures/minimal.v3.adata.zarr/zarr.json +0 -285
- package/test/fixtures/minimal.v3.adata.zarr.json +0 -66
- package/test/fixtures/mouse_liver.h5ad +0 -0
- package/test/fixtures/mouse_liver.h5ad.refspec.json +0 -1
- package/test/fixtures/mouse_liver.py +0 -44
- package/test/fixtures/sparse.adata.zarr/.zattrs +0 -4
- package/test/fixtures/sparse.adata.zarr/.zgroup +0 -3
- package/test/fixtures/sparse.adata.zarr/.zmetadata +0 -304
- package/test/fixtures/sparse.adata.zarr/X/.zattrs +0 -8
- package/test/fixtures/sparse.adata.zarr/X/.zgroup +0 -3
- package/test/fixtures/sparse.adata.zarr/X/data/.zarray +0 -20
- package/test/fixtures/sparse.adata.zarr/X/data/0 +0 -0
- package/test/fixtures/sparse.adata.zarr/X/indices/.zarray +0 -20
- package/test/fixtures/sparse.adata.zarr/X/indices/0 +0 -0
- package/test/fixtures/sparse.adata.zarr/X/indptr/.zarray +0 -20
- package/test/fixtures/sparse.adata.zarr/X/indptr/0 +0 -0
- package/test/fixtures/sparse.adata.zarr/layers/.zattrs +0 -4
- package/test/fixtures/sparse.adata.zarr/layers/.zgroup +0 -3
- package/test/fixtures/sparse.adata.zarr/obs/.zattrs +0 -9
- package/test/fixtures/sparse.adata.zarr/obs/.zgroup +0 -3
- package/test/fixtures/sparse.adata.zarr/obs/_index/.zarray +0 -24
- package/test/fixtures/sparse.adata.zarr/obs/_index/.zattrs +0 -4
- package/test/fixtures/sparse.adata.zarr/obs/_index/0 +0 -0
- package/test/fixtures/sparse.adata.zarr/obs/categorical/.zattrs +0 -5
- package/test/fixtures/sparse.adata.zarr/obs/categorical/.zgroup +0 -3
- package/test/fixtures/sparse.adata.zarr/obs/categorical/categories/.zarray +0 -24
- package/test/fixtures/sparse.adata.zarr/obs/categorical/categories/.zattrs +0 -4
- package/test/fixtures/sparse.adata.zarr/obs/categorical/categories/0 +0 -0
- package/test/fixtures/sparse.adata.zarr/obs/categorical/codes/.zarray +0 -20
- package/test/fixtures/sparse.adata.zarr/obs/categorical/codes/.zattrs +0 -4
- package/test/fixtures/sparse.adata.zarr/obs/categorical/codes/0 +0 -0
- package/test/fixtures/sparse.adata.zarr/obs/string/.zarray +0 -24
- package/test/fixtures/sparse.adata.zarr/obs/string/.zattrs +0 -4
- package/test/fixtures/sparse.adata.zarr/obs/string/0 +0 -0
- package/test/fixtures/sparse.adata.zarr/obsm/.zattrs +0 -4
- package/test/fixtures/sparse.adata.zarr/obsm/.zgroup +0 -3
- package/test/fixtures/sparse.adata.zarr/obsp/.zattrs +0 -4
- package/test/fixtures/sparse.adata.zarr/obsp/.zgroup +0 -3
- package/test/fixtures/sparse.adata.zarr/raw/.zarray +0 -10
- package/test/fixtures/sparse.adata.zarr/raw/.zattrs +0 -4
- package/test/fixtures/sparse.adata.zarr/raw/0 +0 -0
- package/test/fixtures/sparse.adata.zarr/uns/.zattrs +0 -4
- package/test/fixtures/sparse.adata.zarr/uns/.zgroup +0 -3
- package/test/fixtures/sparse.adata.zarr/var/.zattrs +0 -6
- package/test/fixtures/sparse.adata.zarr/var/.zgroup +0 -3
- package/test/fixtures/sparse.adata.zarr/var/_index/.zarray +0 -24
- package/test/fixtures/sparse.adata.zarr/var/_index/.zattrs +0 -4
- package/test/fixtures/sparse.adata.zarr/var/_index/0 +0 -0
- package/test/fixtures/sparse.adata.zarr/varm/.zattrs +0 -4
- package/test/fixtures/sparse.adata.zarr/varm/.zgroup +0 -3
- package/test/fixtures/sparse.adata.zarr/varp/.zattrs +0 -4
- package/test/fixtures/sparse.adata.zarr/varp/.zgroup +0 -3
- package/test/fixtures/sparse.adata.zarr.json +0 -190
- package/test/fixtures/sparse.adata.zmetadata.json +0 -1
- package/test/fixtures/sparse.h5ad +0 -0
- package/test/fixtures/sparse.h5ad.refspec.json +0 -1
- package/test/fixtures/sparse.v3.adata.zarr/X/data/c/0 +0 -0
- package/test/fixtures/sparse.v3.adata.zarr/X/data/zarr.json +0 -40
- package/test/fixtures/sparse.v3.adata.zarr/X/indices/c/0 +0 -0
- package/test/fixtures/sparse.v3.adata.zarr/X/indices/zarr.json +0 -40
- package/test/fixtures/sparse.v3.adata.zarr/X/indptr/c/0 +0 -0
- package/test/fixtures/sparse.v3.adata.zarr/X/indptr/zarr.json +0 -40
- package/test/fixtures/sparse.v3.adata.zarr/X/zarr.json +0 -12
- package/test/fixtures/sparse.v3.adata.zarr/layers/zarr.json +0 -8
- package/test/fixtures/sparse.v3.adata.zarr/obs/_index/c/0 +0 -0
- package/test/fixtures/sparse.v3.adata.zarr/obs/_index/zarr.json +0 -41
- package/test/fixtures/sparse.v3.adata.zarr/obs/categorical/categories/c/0 +0 -0
- package/test/fixtures/sparse.v3.adata.zarr/obs/categorical/categories/zarr.json +0 -41
- package/test/fixtures/sparse.v3.adata.zarr/obs/categorical/codes/c/0 +0 -0
- package/test/fixtures/sparse.v3.adata.zarr/obs/categorical/codes/zarr.json +0 -40
- package/test/fixtures/sparse.v3.adata.zarr/obs/categorical/zarr.json +0 -9
- package/test/fixtures/sparse.v3.adata.zarr/obs/string/c/0 +0 -0
- package/test/fixtures/sparse.v3.adata.zarr/obs/string/zarr.json +0 -41
- package/test/fixtures/sparse.v3.adata.zarr/obs/zarr.json +0 -13
- package/test/fixtures/sparse.v3.adata.zarr/obsm/zarr.json +0 -8
- package/test/fixtures/sparse.v3.adata.zarr/obsp/zarr.json +0 -8
- package/test/fixtures/sparse.v3.adata.zarr/raw/zarr.json +0 -36
- package/test/fixtures/sparse.v3.adata.zarr/uns/zarr.json +0 -8
- package/test/fixtures/sparse.v3.adata.zarr/var/_index/c/0 +0 -0
- package/test/fixtures/sparse.v3.adata.zarr/var/_index/zarr.json +0 -41
- package/test/fixtures/sparse.v3.adata.zarr/var/zarr.json +0 -10
- package/test/fixtures/sparse.v3.adata.zarr/varm/zarr.json +0 -8
- package/test/fixtures/sparse.v3.adata.zarr/varp/zarr.json +0 -8
- package/test/fixtures/sparse.v3.adata.zarr/zarr.json +0 -516
- package/test/fixtures/sparse.v3.adata.zarr.json +0 -114
- package/test/hdf-store.test.ts +0 -268
- package/test/index.test.ts +0 -762
- package/test/partial-reads.test.ts +0 -150
package/README.md
CHANGED
|
@@ -1,4 +1,6 @@
|
|
|
1
|
-
# hdf5-as-virtual-zarr
|
|
1
|
+
# hdf5-as-virtual-zarr.js
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/hdf5-as-virtual-zarr)
|
|
2
4
|
|
|
3
5
|
Given an input HDF5 file URL, generate a Zarr References Specification JSON output.
|
|
4
6
|
|
|
@@ -8,6 +10,20 @@ It supports large HDF5 files using range requests (fetching only the subset of b
|
|
|
8
10
|
|
|
9
11
|
This is a port of [SingleHdf5ToZarr](https://github.com/fsspec/kerchunk/blob/main/kerchunk/hdf.py#L52) and its `translate` function from the `kerchunk` Python package.
|
|
10
12
|
|
|
13
|
+
## Usage
|
|
14
|
+
|
|
15
|
+
```ts
|
|
16
|
+
import { open, get, root } from "zarrita";
|
|
17
|
+
import { FetchStore } from "@zarrita/storage";
|
|
18
|
+
import { HdfStore } from "hdf5-as-virtual-zarr";
|
|
19
|
+
|
|
20
|
+
const internalStore = new FetchStore("https://example.com/data.h5");
|
|
21
|
+
const hdfStore = await HdfStore.fromStore(internalStore);
|
|
22
|
+
|
|
23
|
+
const storeRoot = root(hdfStore);
|
|
24
|
+
const arr = await open(storeRoot.resolve("X"), { kind: "array" });
|
|
25
|
+
const arrData = await get(arr);
|
|
26
|
+
```
|
|
11
27
|
|
|
12
28
|
## Development
|
|
13
29
|
|
|
@@ -32,6 +48,14 @@ pnpm run test
|
|
|
32
48
|
pnpm run build
|
|
33
49
|
```
|
|
34
50
|
|
|
51
|
+
### Preview demo site
|
|
52
|
+
|
|
53
|
+
```sh
|
|
54
|
+
pnpm run demo:build
|
|
55
|
+
pnpm run demo:preview
|
|
56
|
+
# Open http://localhost:4173/hdf5-as-virtual-zarr.js/
|
|
57
|
+
```
|
|
58
|
+
|
|
35
59
|
### Publish
|
|
36
60
|
|
|
37
61
|
```sh
|