ome-zarr-metadata
v0.5.1
Published
A typescript library for interacting with OME-Zarr metadata
Downloads
130
Readme
ome-zarr-metadata
A typescript library for interacting with OME-Zarr metadata.
See zarrita for a typescript library for interacting with Zarr data which may implement the OME-Zarr specification.
Usage notes
In several places, this library distinguishes between the stored "raw" form of the metadata, as defined by the specification, and the "functional" form which is easier to work with in a valid way.
Broadly, interfaces with the suffix Raw
describe the raw form,
and classes describe the functional form.
The classes implement static fromRaw
and toRaw
methods for deserialising from and serialising to the JSON.parse
/ JSON.stringify
-able object forms.
Development
This library is developed using rslib.
Setup
Install the dependencies:
pnpm install
Get Started
Build the library:
pnpm build
Build the library in watch mode:
pnpm dev
Contributions
At present, this library contains implementations for
- [ ] 0.5
- [x] axes
- [x] coordinateTransformations
- [x] multiscales
- [x] labels
- [ ] plate
- [ ] well
- [ ] bioformats2raw.layout
- [ ] omero
- [ ] 0.4
- [ ] 0.3
- [ ] 0.2
- [ ] 0.1
Contributions are welcome for other metadata items and versions.