Skip to content

Commit dcfabb8

Browse files
authored
Add instructions for using OME-Zarr headless (#289)
1 parent 707b304 commit dcfabb8

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

documentation/basics/headless.md

+17
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,23 @@ So valid values for this option are `c`, `t`, and `z`, respectively.
101101
The `*` in each input argument must be provided to ilastik, NOT auto-expanded by the shell before ilastik sees the command!
102102

103103

104+
### Using OME-Zarr input
105+
106+
OME-Zarr URIs are typically shared or provided pointing to the root of a multiscale dataset.
107+
The computations in any ilastik workflow can only run on a single scale, however.
108+
To use an OME-Zarr dataset in headless mode, you have to provide the full path to an individual scale, for example:
109+
110+
$ ./run_ilastik.sh --headless \
111+
--project=MyProject.ilp \
112+
https://s3.embl.de/i2k-2020/platy-raw.ome.zarr/s6
113+
114+
If you don't know the scale name, you can use the Input Data set of any ilastik workflow in the GUI to access the "Add multiscale" dialog.
115+
Paste the root address and click "Check" to see the available scales.
116+
Alternatively, the specific dataset path for each scale is documented in the metadata found in the `.zattrs` file at the multiscale root.
117+
In the above example, this is at `https://s3.embl.de/i2k-2020/platy-raw.ome.zarr/.zattrs`.
118+
If there is no `.zattrs` file in your case, the dataset may be OME-Zarr version 0.5.
119+
In this case, the file is called `zarr.json` instead. OME-Zarr stores in this version are currently not supported by ilastik, however.
120+
104121
## Output Options
105122

106123
By default, ilastik will export the results in hdf5 format, stored to the same directory as the input image.

0 commit comments

Comments
 (0)