Skip to content

Commit 7e3af90

Browse files
Merge pull request #3 from BioImageTools/add-biongff-viewer-manifest
feat: add biongff viewer manifest
2 parents abb2675 + 2cfc4f8 commit 7e3af90

2 files changed

Lines changed: 56 additions & 2 deletions

File tree

example.yaml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
1-
21
viewer:
32
name: "MyDataViewer"
43
version: "2.3.1"
54
repo: "https://github.com/org/viewer"
65
template_url: "https://example.com/viewer?url={DATA_URL}"
7-
6+
87
capabilities:
98
# Enumeration of OME-Zarr versions that can be loaded
109
ome_zarr_versions: [0.4, 0.5]
1110

11+
# Compression codecs the tool can decode. An empty array `[]` means the tool does not declare codec support — compatibility is unknown rather than unsupported.
12+
compression_codecs: ["blosc", "zstd", "gzip"]
13+
1214
# Which additional RFCs are supported?
1315
rfcs_supported: [5, 9]
1416

manifests/biongff-viewer.yaml

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
viewer:
2+
name: "BioNGFF Viewer"
3+
version: "0.1.0"
4+
repo: "https://github.com/BioNGFF/biongff-viewer"
5+
template_url: "https://biongff.github.io/biongff-viewer/?source={DATA_URL}"
6+
7+
capabilities:
8+
# Enumeration of OME-Zarr versions that can be loaded
9+
ome_zarr_versions: [0.4, 0.5]
10+
11+
# Compression codecs the tool can decode. An empty array `[]` means the tool does not declare codec support — compatibility is unknown rather than unsupported.
12+
compression_codecs:
13+
[
14+
"blosc",
15+
"lz4",
16+
"zstd",
17+
"gzip",
18+
"zlib",
19+
"transpose",
20+
"bytes",
21+
"crc32c",
22+
"vlen-utf8",
23+
"json2",
24+
"bitround",
25+
]
26+
27+
# Are axis names and units respected?
28+
axes: true
29+
30+
# Are scaling factors respected on multiscales?
31+
scale: false
32+
33+
# Are translation factors respected on multiscales (including subpixel offsets for lower scale levels)?
34+
translation: false
35+
36+
# Does the tool support multiple channels?
37+
channels: true
38+
39+
# Does the tool support multiple timepoints?
40+
timepoints: true
41+
42+
# Are labels loaded when available?
43+
labels: true
44+
45+
# Are HCS plates loaded when available?
46+
hcs_plates: true
47+
48+
# Does the viewer handle multiple images in a bioformats2raw layout?
49+
bioformats2raw_layout: true
50+
51+
# Is the OMERO metadata used to e.g. color the channels?
52+
omero_metadata: true

0 commit comments

Comments
 (0)