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.
Files changed (247) hide show
  1. package/README.md +25 -1
  2. package/dist/bundled/index.js +3338 -0
  3. package/dist/bundled/index.js.map +1 -0
  4. package/dist/encoding.d.ts +21 -0
  5. package/dist/encoding.js +62 -0
  6. package/dist/hdf-store.d.ts +21 -4
  7. package/dist/hdf-store.js +23 -3
  8. package/dist/index.d.ts +2 -1
  9. package/dist/index.js +2 -1
  10. package/dist/jsfive/dataobjects.js +14 -0
  11. package/dist/jsfive/datatype-msg.d.ts +1 -0
  12. package/dist/jsfive/datatype-msg.js +58 -1
  13. package/dist/ref-spec-to-consolidated-metadata.d.ts +19 -0
  14. package/dist/ref-spec-to-consolidated-metadata.js +25 -0
  15. package/dist/ref-spec-v2-to-v3.d.ts +13 -0
  16. package/dist/ref-spec-v2-to-v3.js +177 -0
  17. package/dist/ref-store.d.ts +3 -3
  18. package/dist/ref-store.js +5 -2
  19. package/dist/single-hdf5-to-zarr.d.ts +6 -0
  20. package/dist/single-hdf5-to-zarr.js +68 -41
  21. package/dist/types.d.ts +5 -1
  22. package/package.json +12 -7
  23. package/src/encoding.ts +64 -0
  24. package/src/hdf-store.ts +30 -6
  25. package/src/index.ts +2 -1
  26. package/src/jsfive/dataobjects.ts +12 -0
  27. package/src/jsfive/datatype-msg.ts +67 -1
  28. package/src/ref-spec-to-consolidated-metadata.ts +45 -0
  29. package/src/ref-spec-v2-to-v3.ts +199 -0
  30. package/src/ref-store.ts +8 -5
  31. package/src/single-hdf5-to-zarr.ts +60 -47
  32. package/src/types.ts +6 -1
  33. package/test/fixtures/dense.adata.zarr/.zattrs +0 -4
  34. package/test/fixtures/dense.adata.zarr/.zgroup +0 -3
  35. package/test/fixtures/dense.adata.zarr/.zmetadata +0 -285
  36. package/test/fixtures/dense.adata.zarr/X/.zarray +0 -22
  37. package/test/fixtures/dense.adata.zarr/X/.zattrs +0 -4
  38. package/test/fixtures/dense.adata.zarr/X/0.0 +0 -0
  39. package/test/fixtures/dense.adata.zarr/layers/.zattrs +0 -4
  40. package/test/fixtures/dense.adata.zarr/layers/.zgroup +0 -3
  41. package/test/fixtures/dense.adata.zarr/obs/.zattrs +0 -9
  42. package/test/fixtures/dense.adata.zarr/obs/.zgroup +0 -3
  43. package/test/fixtures/dense.adata.zarr/obs/_index/.zarray +0 -24
  44. package/test/fixtures/dense.adata.zarr/obs/_index/.zattrs +0 -4
  45. package/test/fixtures/dense.adata.zarr/obs/_index/0 +0 -0
  46. package/test/fixtures/dense.adata.zarr/obs/categorical/.zattrs +0 -5
  47. package/test/fixtures/dense.adata.zarr/obs/categorical/.zgroup +0 -3
  48. package/test/fixtures/dense.adata.zarr/obs/categorical/categories/.zarray +0 -24
  49. package/test/fixtures/dense.adata.zarr/obs/categorical/categories/.zattrs +0 -4
  50. package/test/fixtures/dense.adata.zarr/obs/categorical/categories/0 +0 -0
  51. package/test/fixtures/dense.adata.zarr/obs/categorical/codes/.zarray +0 -20
  52. package/test/fixtures/dense.adata.zarr/obs/categorical/codes/.zattrs +0 -4
  53. package/test/fixtures/dense.adata.zarr/obs/categorical/codes/0 +0 -0
  54. package/test/fixtures/dense.adata.zarr/obs/string/.zarray +0 -24
  55. package/test/fixtures/dense.adata.zarr/obs/string/.zattrs +0 -4
  56. package/test/fixtures/dense.adata.zarr/obs/string/0 +0 -0
  57. package/test/fixtures/dense.adata.zarr/obsm/.zattrs +0 -4
  58. package/test/fixtures/dense.adata.zarr/obsm/.zgroup +0 -3
  59. package/test/fixtures/dense.adata.zarr/obsm/X_umap/.zarray +0 -22
  60. package/test/fixtures/dense.adata.zarr/obsm/X_umap/.zattrs +0 -4
  61. package/test/fixtures/dense.adata.zarr/obsm/X_umap/0.0 +0 -0
  62. package/test/fixtures/dense.adata.zarr/obsp/.zattrs +0 -4
  63. package/test/fixtures/dense.adata.zarr/obsp/.zgroup +0 -3
  64. package/test/fixtures/dense.adata.zarr/raw/.zarray +0 -10
  65. package/test/fixtures/dense.adata.zarr/raw/.zattrs +0 -4
  66. package/test/fixtures/dense.adata.zarr/raw/0 +0 -0
  67. package/test/fixtures/dense.adata.zarr/uns/.zattrs +0 -4
  68. package/test/fixtures/dense.adata.zarr/uns/.zgroup +0 -3
  69. package/test/fixtures/dense.adata.zarr/var/.zattrs +0 -6
  70. package/test/fixtures/dense.adata.zarr/var/.zgroup +0 -3
  71. package/test/fixtures/dense.adata.zarr/var/_index/.zarray +0 -24
  72. package/test/fixtures/dense.adata.zarr/var/_index/.zattrs +0 -4
  73. package/test/fixtures/dense.adata.zarr/var/_index/0 +0 -0
  74. package/test/fixtures/dense.adata.zarr/varm/.zattrs +0 -4
  75. package/test/fixtures/dense.adata.zarr/varm/.zgroup +0 -3
  76. package/test/fixtures/dense.adata.zarr/varp/.zattrs +0 -4
  77. package/test/fixtures/dense.adata.zarr/varp/.zgroup +0 -3
  78. package/test/fixtures/dense.adata.zarr.json +0 -182
  79. package/test/fixtures/dense.adata.zmetadata.json +0 -1
  80. package/test/fixtures/dense.h5ad +0 -0
  81. package/test/fixtures/dense.h5ad.refspec.json +0 -1
  82. package/test/fixtures/dense.v3.adata.zarr/X/c/0/0 +0 -0
  83. package/test/fixtures/dense.v3.adata.zarr/X/zarr.json +0 -45
  84. package/test/fixtures/dense.v3.adata.zarr/layers/zarr.json +0 -8
  85. package/test/fixtures/dense.v3.adata.zarr/obs/_index/c/0 +0 -0
  86. package/test/fixtures/dense.v3.adata.zarr/obs/_index/zarr.json +0 -41
  87. package/test/fixtures/dense.v3.adata.zarr/obs/categorical/categories/c/0 +0 -0
  88. package/test/fixtures/dense.v3.adata.zarr/obs/categorical/categories/zarr.json +0 -41
  89. package/test/fixtures/dense.v3.adata.zarr/obs/categorical/codes/c/0 +0 -0
  90. package/test/fixtures/dense.v3.adata.zarr/obs/categorical/codes/zarr.json +0 -40
  91. package/test/fixtures/dense.v3.adata.zarr/obs/categorical/zarr.json +0 -9
  92. package/test/fixtures/dense.v3.adata.zarr/obs/string/c/0 +0 -0
  93. package/test/fixtures/dense.v3.adata.zarr/obs/string/zarr.json +0 -41
  94. package/test/fixtures/dense.v3.adata.zarr/obs/zarr.json +0 -13
  95. package/test/fixtures/dense.v3.adata.zarr/obsm/X_umap/c/0/0 +0 -0
  96. package/test/fixtures/dense.v3.adata.zarr/obsm/X_umap/zarr.json +0 -45
  97. package/test/fixtures/dense.v3.adata.zarr/obsm/zarr.json +0 -8
  98. package/test/fixtures/dense.v3.adata.zarr/obsp/zarr.json +0 -8
  99. package/test/fixtures/dense.v3.adata.zarr/raw/zarr.json +0 -36
  100. package/test/fixtures/dense.v3.adata.zarr/uns/zarr.json +0 -8
  101. package/test/fixtures/dense.v3.adata.zarr/var/_index/c/0 +0 -0
  102. package/test/fixtures/dense.v3.adata.zarr/var/_index/zarr.json +0 -41
  103. package/test/fixtures/dense.v3.adata.zarr/var/zarr.json +0 -10
  104. package/test/fixtures/dense.v3.adata.zarr/varm/zarr.json +0 -8
  105. package/test/fixtures/dense.v3.adata.zarr/varp/zarr.json +0 -8
  106. package/test/fixtures/dense.v3.adata.zarr/zarr.json +0 -469
  107. package/test/fixtures/dense.v3.adata.zarr.json +0 -102
  108. package/test/fixtures/generate_fixtures.py +0 -157
  109. package/test/fixtures/generate_fixtures_v3.py +0 -126
  110. package/test/fixtures/minimal.adata.zarr/.zattrs +0 -4
  111. package/test/fixtures/minimal.adata.zarr/.zgroup +0 -3
  112. package/test/fixtures/minimal.adata.zarr/.zmetadata +0 -168
  113. package/test/fixtures/minimal.adata.zarr/X/.zarray +0 -22
  114. package/test/fixtures/minimal.adata.zarr/X/.zattrs +0 -4
  115. package/test/fixtures/minimal.adata.zarr/X/0.0 +0 -0
  116. package/test/fixtures/minimal.adata.zarr/layers/.zattrs +0 -4
  117. package/test/fixtures/minimal.adata.zarr/layers/.zgroup +0 -3
  118. package/test/fixtures/minimal.adata.zarr/obs/.zattrs +0 -6
  119. package/test/fixtures/minimal.adata.zarr/obs/.zgroup +0 -3
  120. package/test/fixtures/minimal.adata.zarr/obs/_index/.zarray +0 -24
  121. package/test/fixtures/minimal.adata.zarr/obs/_index/.zattrs +0 -4
  122. package/test/fixtures/minimal.adata.zarr/obs/_index/0 +0 -0
  123. package/test/fixtures/minimal.adata.zarr/obsm/.zattrs +0 -4
  124. package/test/fixtures/minimal.adata.zarr/obsm/.zgroup +0 -3
  125. package/test/fixtures/minimal.adata.zarr/obsp/.zattrs +0 -4
  126. package/test/fixtures/minimal.adata.zarr/obsp/.zgroup +0 -3
  127. package/test/fixtures/minimal.adata.zarr/raw/.zarray +0 -10
  128. package/test/fixtures/minimal.adata.zarr/raw/.zattrs +0 -4
  129. package/test/fixtures/minimal.adata.zarr/raw/0 +0 -0
  130. package/test/fixtures/minimal.adata.zarr/uns/.zattrs +0 -4
  131. package/test/fixtures/minimal.adata.zarr/uns/.zgroup +0 -3
  132. package/test/fixtures/minimal.adata.zarr/var/.zattrs +0 -6
  133. package/test/fixtures/minimal.adata.zarr/var/.zgroup +0 -3
  134. package/test/fixtures/minimal.adata.zarr/var/_index/.zarray +0 -24
  135. package/test/fixtures/minimal.adata.zarr/var/_index/.zattrs +0 -4
  136. package/test/fixtures/minimal.adata.zarr/var/_index/0 +0 -0
  137. package/test/fixtures/minimal.adata.zarr/varm/.zattrs +0 -4
  138. package/test/fixtures/minimal.adata.zarr/varm/.zgroup +0 -3
  139. package/test/fixtures/minimal.adata.zarr/varp/.zattrs +0 -4
  140. package/test/fixtures/minimal.adata.zarr/varp/.zgroup +0 -3
  141. package/test/fixtures/minimal.adata.zarr.json +0 -126
  142. package/test/fixtures/minimal.adata.zmetadata.json +0 -1
  143. package/test/fixtures/minimal.h5ad +0 -0
  144. package/test/fixtures/minimal.h5ad.refspec.json +0 -1
  145. package/test/fixtures/minimal.v3.adata.zarr/X/c/0/0 +0 -0
  146. package/test/fixtures/minimal.v3.adata.zarr/X/zarr.json +0 -45
  147. package/test/fixtures/minimal.v3.adata.zarr/layers/zarr.json +0 -8
  148. package/test/fixtures/minimal.v3.adata.zarr/obs/_index/c/0 +0 -0
  149. package/test/fixtures/minimal.v3.adata.zarr/obs/_index/zarr.json +0 -41
  150. package/test/fixtures/minimal.v3.adata.zarr/obs/zarr.json +0 -10
  151. package/test/fixtures/minimal.v3.adata.zarr/obsm/zarr.json +0 -8
  152. package/test/fixtures/minimal.v3.adata.zarr/obsp/zarr.json +0 -8
  153. package/test/fixtures/minimal.v3.adata.zarr/raw/zarr.json +0 -36
  154. package/test/fixtures/minimal.v3.adata.zarr/uns/zarr.json +0 -8
  155. package/test/fixtures/minimal.v3.adata.zarr/var/_index/c/0 +0 -0
  156. package/test/fixtures/minimal.v3.adata.zarr/var/_index/zarr.json +0 -41
  157. package/test/fixtures/minimal.v3.adata.zarr/var/zarr.json +0 -10
  158. package/test/fixtures/minimal.v3.adata.zarr/varm/zarr.json +0 -8
  159. package/test/fixtures/minimal.v3.adata.zarr/varp/zarr.json +0 -8
  160. package/test/fixtures/minimal.v3.adata.zarr/zarr.json +0 -285
  161. package/test/fixtures/minimal.v3.adata.zarr.json +0 -66
  162. package/test/fixtures/mouse_liver.h5ad +0 -0
  163. package/test/fixtures/mouse_liver.h5ad.refspec.json +0 -1
  164. package/test/fixtures/mouse_liver.py +0 -44
  165. package/test/fixtures/sparse.adata.zarr/.zattrs +0 -4
  166. package/test/fixtures/sparse.adata.zarr/.zgroup +0 -3
  167. package/test/fixtures/sparse.adata.zarr/.zmetadata +0 -304
  168. package/test/fixtures/sparse.adata.zarr/X/.zattrs +0 -8
  169. package/test/fixtures/sparse.adata.zarr/X/.zgroup +0 -3
  170. package/test/fixtures/sparse.adata.zarr/X/data/.zarray +0 -20
  171. package/test/fixtures/sparse.adata.zarr/X/data/0 +0 -0
  172. package/test/fixtures/sparse.adata.zarr/X/indices/.zarray +0 -20
  173. package/test/fixtures/sparse.adata.zarr/X/indices/0 +0 -0
  174. package/test/fixtures/sparse.adata.zarr/X/indptr/.zarray +0 -20
  175. package/test/fixtures/sparse.adata.zarr/X/indptr/0 +0 -0
  176. package/test/fixtures/sparse.adata.zarr/layers/.zattrs +0 -4
  177. package/test/fixtures/sparse.adata.zarr/layers/.zgroup +0 -3
  178. package/test/fixtures/sparse.adata.zarr/obs/.zattrs +0 -9
  179. package/test/fixtures/sparse.adata.zarr/obs/.zgroup +0 -3
  180. package/test/fixtures/sparse.adata.zarr/obs/_index/.zarray +0 -24
  181. package/test/fixtures/sparse.adata.zarr/obs/_index/.zattrs +0 -4
  182. package/test/fixtures/sparse.adata.zarr/obs/_index/0 +0 -0
  183. package/test/fixtures/sparse.adata.zarr/obs/categorical/.zattrs +0 -5
  184. package/test/fixtures/sparse.adata.zarr/obs/categorical/.zgroup +0 -3
  185. package/test/fixtures/sparse.adata.zarr/obs/categorical/categories/.zarray +0 -24
  186. package/test/fixtures/sparse.adata.zarr/obs/categorical/categories/.zattrs +0 -4
  187. package/test/fixtures/sparse.adata.zarr/obs/categorical/categories/0 +0 -0
  188. package/test/fixtures/sparse.adata.zarr/obs/categorical/codes/.zarray +0 -20
  189. package/test/fixtures/sparse.adata.zarr/obs/categorical/codes/.zattrs +0 -4
  190. package/test/fixtures/sparse.adata.zarr/obs/categorical/codes/0 +0 -0
  191. package/test/fixtures/sparse.adata.zarr/obs/string/.zarray +0 -24
  192. package/test/fixtures/sparse.adata.zarr/obs/string/.zattrs +0 -4
  193. package/test/fixtures/sparse.adata.zarr/obs/string/0 +0 -0
  194. package/test/fixtures/sparse.adata.zarr/obsm/.zattrs +0 -4
  195. package/test/fixtures/sparse.adata.zarr/obsm/.zgroup +0 -3
  196. package/test/fixtures/sparse.adata.zarr/obsp/.zattrs +0 -4
  197. package/test/fixtures/sparse.adata.zarr/obsp/.zgroup +0 -3
  198. package/test/fixtures/sparse.adata.zarr/raw/.zarray +0 -10
  199. package/test/fixtures/sparse.adata.zarr/raw/.zattrs +0 -4
  200. package/test/fixtures/sparse.adata.zarr/raw/0 +0 -0
  201. package/test/fixtures/sparse.adata.zarr/uns/.zattrs +0 -4
  202. package/test/fixtures/sparse.adata.zarr/uns/.zgroup +0 -3
  203. package/test/fixtures/sparse.adata.zarr/var/.zattrs +0 -6
  204. package/test/fixtures/sparse.adata.zarr/var/.zgroup +0 -3
  205. package/test/fixtures/sparse.adata.zarr/var/_index/.zarray +0 -24
  206. package/test/fixtures/sparse.adata.zarr/var/_index/.zattrs +0 -4
  207. package/test/fixtures/sparse.adata.zarr/var/_index/0 +0 -0
  208. package/test/fixtures/sparse.adata.zarr/varm/.zattrs +0 -4
  209. package/test/fixtures/sparse.adata.zarr/varm/.zgroup +0 -3
  210. package/test/fixtures/sparse.adata.zarr/varp/.zattrs +0 -4
  211. package/test/fixtures/sparse.adata.zarr/varp/.zgroup +0 -3
  212. package/test/fixtures/sparse.adata.zarr.json +0 -190
  213. package/test/fixtures/sparse.adata.zmetadata.json +0 -1
  214. package/test/fixtures/sparse.h5ad +0 -0
  215. package/test/fixtures/sparse.h5ad.refspec.json +0 -1
  216. package/test/fixtures/sparse.v3.adata.zarr/X/data/c/0 +0 -0
  217. package/test/fixtures/sparse.v3.adata.zarr/X/data/zarr.json +0 -40
  218. package/test/fixtures/sparse.v3.adata.zarr/X/indices/c/0 +0 -0
  219. package/test/fixtures/sparse.v3.adata.zarr/X/indices/zarr.json +0 -40
  220. package/test/fixtures/sparse.v3.adata.zarr/X/indptr/c/0 +0 -0
  221. package/test/fixtures/sparse.v3.adata.zarr/X/indptr/zarr.json +0 -40
  222. package/test/fixtures/sparse.v3.adata.zarr/X/zarr.json +0 -12
  223. package/test/fixtures/sparse.v3.adata.zarr/layers/zarr.json +0 -8
  224. package/test/fixtures/sparse.v3.adata.zarr/obs/_index/c/0 +0 -0
  225. package/test/fixtures/sparse.v3.adata.zarr/obs/_index/zarr.json +0 -41
  226. package/test/fixtures/sparse.v3.adata.zarr/obs/categorical/categories/c/0 +0 -0
  227. package/test/fixtures/sparse.v3.adata.zarr/obs/categorical/categories/zarr.json +0 -41
  228. package/test/fixtures/sparse.v3.adata.zarr/obs/categorical/codes/c/0 +0 -0
  229. package/test/fixtures/sparse.v3.adata.zarr/obs/categorical/codes/zarr.json +0 -40
  230. package/test/fixtures/sparse.v3.adata.zarr/obs/categorical/zarr.json +0 -9
  231. package/test/fixtures/sparse.v3.adata.zarr/obs/string/c/0 +0 -0
  232. package/test/fixtures/sparse.v3.adata.zarr/obs/string/zarr.json +0 -41
  233. package/test/fixtures/sparse.v3.adata.zarr/obs/zarr.json +0 -13
  234. package/test/fixtures/sparse.v3.adata.zarr/obsm/zarr.json +0 -8
  235. package/test/fixtures/sparse.v3.adata.zarr/obsp/zarr.json +0 -8
  236. package/test/fixtures/sparse.v3.adata.zarr/raw/zarr.json +0 -36
  237. package/test/fixtures/sparse.v3.adata.zarr/uns/zarr.json +0 -8
  238. package/test/fixtures/sparse.v3.adata.zarr/var/_index/c/0 +0 -0
  239. package/test/fixtures/sparse.v3.adata.zarr/var/_index/zarr.json +0 -41
  240. package/test/fixtures/sparse.v3.adata.zarr/var/zarr.json +0 -10
  241. package/test/fixtures/sparse.v3.adata.zarr/varm/zarr.json +0 -8
  242. package/test/fixtures/sparse.v3.adata.zarr/varp/zarr.json +0 -8
  243. package/test/fixtures/sparse.v3.adata.zarr/zarr.json +0 -516
  244. package/test/fixtures/sparse.v3.adata.zarr.json +0 -114
  245. package/test/hdf-store.test.ts +0 -268
  246. package/test/index.test.ts +0 -762
  247. 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
+ [![NPM](https://img.shields.io/npm/v/hdf5-as-virtual-zarr.svg?color=black)](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