Zarr filesystem backend for N5.
This library provides best effort compatibility with existing Zarr v2 data stored in filesystem containers. So far, I have tested
Blosc compressors depend on n5-blosc
which depends on libblosc1
, On Ubuntu 18.04 or later, install with:
sudo apt-get install -y libblosc1
On other platforms, please check the installation instructions for JBlosc.
Build and install:
mvn clean install
This also works without Blosc compression if not available.
This implementation currently supports the following Zarr features
Fill value behavior is not well tested because I had no good idea what the best solution is. They are currently interpreted as numbers (if possible) including the special cases "NaN", "Infinity", and "-Infinity" for floating point numbers. Some hickups expected for other data.
Filters are not currently supported because I feel ambiguous about them. Please let me know of use cases that I am missing, it is not hard to add data filters of any kind. I just cannot come up with a single thing that I would like to do here right now.
Optionally, N5 dataset attributes ("dimensions", "blockSize", "compression", "dataType") can be virtually mapped such that N5-API based code that reads or writes them directly via general attribute access will see and modify the corresponding zarray (dataset) attributes. Keep in mind that this will lead to name clashes if a Zarr dataset uses any of these attributes for other purposes, try switching the mapping off first if that is an issue.
TODO add code examples. For now, have a look at the tests.