Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
4c29921
remove leftover reference to bikeshed
lubianat Jul 28, 2026
87eb2e6
fix broken links in a-z
lubianat Jul 28, 2026
2e0f2e1
fix internal link for 0.5 (soon to change)
lubianat Jul 28, 2026
70d2f4f
Fix boldface errors
lubianat Jul 28, 2026
4edff7a
change links to use https
lubianat Jul 28, 2026
d327d10
fix anchors and refs in rfc1
lubianat Jul 29, 2026
b310e48
fix internal links and anchors
lubianat Jul 29, 2026
da50802
fix link to rfc1
lubianat Jul 29, 2026
a3d8cc7
Add html-proofer linking
lubianat Jul 29, 2026
62f9f6d
adapt html-proofer action to this context
lubianat Jul 29, 2026
7fc4159
docs: rollback auto-formatting on rfc 3
lubianat Aug 4, 2026
fb988cb
docs: Fix broken internal links after rollback
lubianat Aug 4, 2026
f704c11
move questions in the landing page to the FAQ
lubianat Aug 4, 2026
5e0e75b
Draft new look for the landing page
lubianat Aug 4, 2026
64930c5
feat: arrange cards in grid with placeholders
lubianat Aug 5, 2026
bf68534
Add images+emojis to main page
lubianat Aug 5, 2026
87c407c
add DOI to paper below
lubianat Aug 5, 2026
73542a3
Re-add TOC tree
lubianat Aug 5, 2026
1160b79
Fix link to RFCs; re-remove TOC tree
lubianat Aug 5, 2026
fc58554
Make the toctree hidden
lubianat Aug 5, 2026
ad50db5
Improve organization of images and text on the grid
lubianat Aug 5, 2026
0137080
Merge branch 'main' into landing-page-redo
lubianat Aug 7, 2026
e4b5913
fix css media tags
lubianat Aug 7, 2026
3b8ac6d
Remove duplicated Y/Z glossary sections
Copilot Aug 7, 2026
ebd9958
disable pre-fetch for cards (fix navigation bug)
lubianat Aug 7, 2026
1b7f1cf
Merge branch 'landing-page-redo' of github.com:ome/ngff into landing-…
lubianat Aug 7, 2026
b3f8bed
Remove custom css for hovering; testing if it works on RTD
lubianat Aug 7, 2026
33ac9e6
Remove all custom CSS about cards
lubianat Aug 7, 2026
01f2cdd
try to disable injected linkpreview from cards
lubianat Aug 7, 2026
699375a
Add TODOs that document the patches over RTD extension
lubianat Aug 18, 2026
c51bc80
Remove source link tip
lubianat Aug 20, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions _static/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
/* hero */
h1:has(+ .ome-hero) {
text-align: center;
font-size: 4rem;
font-weight: 700;
letter-spacing: -0.02em;
margin-bottom: 0.5rem;
}
.ome-hero {
text-align: center;
margin: 0 auto 3rem;
}
.ome-hero p {
font-size: 1.25rem;
color: var(--pst-color-text-muted);
max-width: 42rem;
margin: 0 auto;
}
@media (max-width: 768px) {
.ome-hero h1 { font-size: 2.5rem; }
}
Comment thread
Copilot marked this conversation as resolved.

/* cards */
.sd-row { align-items: stretch; }
.sd-col { display: flex; }
.sd-card {
border-radius: 12px;
overflow: hidden;
transition: transform 0.15s ease, box-shadow 0.15s ease;
}
.sd-card:hover {
transform: translateY(-4px);
box-shadow: 0 8px 24px rgba(0, 0, 0, 0.08);
}
.sd-card img {
aspect-ratio: 16 / 9;
object-fit: cover;
}

/* The snippet below is needed as sphinx-design cards with links
and the RTD link-preview extension are not playing well together.
TODO: Remove this if moving away from RTD or disabling the link-preview extension.*/
.tooltip[data-linkpreview-href] { display: none !important; pointer-events: none !important; }
.tooltip[data-linkpreview-href] iframe { display: none !important; }
10 changes: 10 additions & 0 deletions _static/main.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
$(document).ready( function () {
$('table.datatable').DataTable();
} );

// The snippet below is needed as sphinx-design cards with links
// and the RTD link-preview extension don't play well together.
// TODO: Remove this if moving away from RTD or disabling the link-preview extension.
document.addEventListener("readthedocs-addons-data-ready", function () {
document.querySelectorAll("a.link-preview, .sd-card a.sd-stretched-link").forEach(function (a) {
a.classList.remove("link-preview");
a.removeAttribute("data-linkpreview-href");
});
});
1 change: 1 addition & 0 deletions community/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
(community-main)=
# Community

## Community Calls
Expand Down
2 changes: 2 additions & 0 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@

html_css_files = [
"https://cdn.datatables.net/v/dt/dt-1.11.5/datatables.min.css",
"custom.css"
]

html_js_files = [
Expand All @@ -92,6 +93,7 @@
"_html_extra",
]

html_show_sourcelink = False

def build_served_html():
import glob
Expand Down
220 changes: 149 additions & 71 deletions help-desk/index.md

Large diffs are not rendered by default.

Binary file added images/contributors-map-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/resources-screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/spec-screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
105 changes: 46 additions & 59 deletions index.md
Original file line number Diff line number Diff line change
@@ -1,85 +1,72 @@
(main-page)=
# Next-Generation File Formats (NGFF) + OME-Zarr

Welcome to the Next-Generation File Formats (NGFF) main page! This site is dedicated to providing resources for the NGFF community and those that are interested in getting started with OME-Zarr.
# OME-Zarr

In summary, OME-Zarr allows you to store, share and stream large images. You can browse samples of such data from the Image Data Resource at <https://idr.github.io/ome-ngff-samples/>.
:::{div} ome-hero

## NGFF vs OME-Zarr, what is the difference?
A cloud-friendly, FAIR, AI-ready, community-driven open format for bioimaging data.
:::

**OME-Zarr** is the file format that the NGFF community has settled on to address issues of scalability and interoperability described below.
::::{grid} 1 2 2 3
:gutter: 3

**NGFF** is the community-driven process for designing the next generation of bioimaging formats. NGFF brings together the community to define shared specifications, metadata standards, and best practices. OME-Zarr implements those decisions, providing a practical, open, and scalable way to store and share modern microscopy data. As the NGFF specifications evolve, OME-Zarr evolves with them — ensuring the format reflects the needs and experience of the wider community.
:::{grid-item-card} Community 💬
:link: community-main
:link-type: ref
:img-top: ./images/contributors-map-light.png

## What is an OME-Zarr?
A global community of developers and users working together to streamline bioimaging data management and analysis.
:::

An OME-Zarr is a file format optimized for storing, viewing, & sharing large images.
There are two parts to an OME-Zarr:
:::{grid-item-card} Specifications 📜
:link: specifications-main
:link-type: ref
:img-top: ./images/spec-screenshot.png

- **The "Zarr" part describes how the pixel data for the images are laid out**. [Zarr](https://zarr.dev) is a next-generation data format used for scientific datasets in multiple domains.
- **The "OME" part describes metadata about the pixel data.** OME stands for [Open Microscopy Environment](https://www.openmicroscopy.org/). This includes metadata such as:
- spatial relationships
- high content screening data
- well data
- [and more](./specifications/index)!
Details for developers and implementers of OME-Zarr on the stable and development releases of the specification.
:::

## Why would I use OME-Zarr?
:::{grid-item-card} RFCs ❗
:link: rfc-main
:link-type: ref
:img-top: ./rfc/1/drawing.png

In general, OME-Zarr is growing as a default [FAIR](https://en.wikipedia.org/wiki/FAIR_data) choice for storing and sharing microscopy images.
The documents and discussions through which the community shapes the development of OME-Zarr. Anyone can participate.
:::

OME-Zarr files have two major benefits:
:::{grid-item-card} Resources 📚
:link: resources-main
:link-type: ref
:img-top: ./images/resources-screenshot.png

- **Standardization:** "OME-Zarr" is a "Zarr" with embedded standardized metadata in the Open Microscopy Environment (OME) format.
- **_Sharing_**: It eases cross-organization file sharing, aiding organizational collaboration and data sharing. Repositories like the [Image Data Resource](https://idr.openmicroscopy.org/) and [BioImage Archive](https://www.ebi.ac.uk/bioimage-archive/) are currently migrating to having OME-Zarr as a standard format for _all_ their data.
- **_Interoperability_**: Standardized metadata enables the ability to "mix and match" tools from different organizations, benefiting from the strengths of multiple tools as needed.
A collection of resources for users and developers, including datasets, tools, publications, and learning materials.
:::

- **Parallel access**: Chunking is inherent to "Zarr" files. This means "Zarr" files are stored in independently-accessible blocks.
- **_Storage_**: Microscopy images can be quite large and can therefore reach Cloud system storage limits for individual files; the chunked nature of a Zarr can alleviate this issue. Some storage systems may also duplicate byte-equivalent files, so a chunked file like Zarr may save storage space.
- **_Viewing_**: Viewers can target specific chunks to load based upon the current view, reducing lag, & enabling massive images to be viewed within browsers.
- **_Cost_**: When viewing or reading data, the total cost of accessing a Zarr file on the cloud may be less than a more monolithic file format due to the more efficient data access patterns. Ex. A viewer can just access the chunks of the image it needs to display rather than the entire image.
:::{grid-item-card} Publications 📢
:link: resources-publications
:link-type: ref
Comment thread
lubianat marked this conversation as resolved.
:img-top: https://media.springernature.com/full/springer-static/image/art%3A10.1007%2Fs00418-023-02209-1/MediaObjects/418_2023_2209_Fig1_HTML.png?as=webp

Of note, both benefits contribute to **_AI-readiness_**: the standardized metadata & access patterns provide a common layer for machine-learning workflows, reducing the friction for developers to build and test models.
Papers and preprints written by the OME-NGFF community or using OME-Zarr.
:::

The [tools](#resources-tools), [data](#resources-data), and [ecosystem](#resources-ecosystem) may provide a better sense of the range of scientific use cases that may benefit from OME-Zarr. The [publications](#resources-publications) page provides a list of publications that have used OME-Zarr in their work.
:::{grid-item-card} Help Desk ☎️
:link: help-desk-main
:link-type: ref
:img-top: ./images/hackathons/IMG_9605.jpeg

## When would I not use OME-Zarr?
FAQs and directions on getting support with OME-Zarr.
:::

While the format matures, it may be frustrating to use OME-Zarr in some cases, for example:
::::

- If you are working with small images, not planning to share them and your current tools already work well, then using OME-Zarr may not be necessary. Planned expansions to the specification (such as single-file Zarrs) will make it more convenient in these scenarios.
OME-Zarr is a combination of the [Zarr](https://zarr.dev) format for cloud-optimized storage of scientific arrays and a custom [Open Microscopy Environment (OME)](https://www.openmicroscopy.org/) metadata model, tailored for modern bioimaging needs.

- If you need specific conditions for which OME-Zarr support is not mature, you may need to use a different file format.
- Particularly, if your original file is lossy compressed, you will see a large increase in file size (about an order of magnitude) as the images are decompressed into OME-Zarr, since transferring lossy compressed tiles is not yet supported. This currently impacts most whole slide image (WSI) formats such as SVS, CZI, and NDPI, which are lossy JPEG compressed by default.

## Who is using OME-Zarr?

These are _some_ of the organizations (and their dataset pages) that are using OME-Zarr for their data.

- [Allen Institute](https://bff.allencell.org/datasets)
- biohub
- [Broad Institute](https://broadinstitute.github.io/cellpainting-gallery/overview.html)
- [EMBL - Image Data Resource (IDR)](https://idr.openmicroscopy.org/)
- [Howard Hughes Medical Institute, Janelia (HHMI)](https://openorganelle.janelia.org/)
- [Jackson Laboratory (JAX)](https://images.jax.org/)
- ... [and more](#resources-data)

## How do I use OME-Zarr?

- Already have a Zarr?
- Check out the [tools section](#resources-tools)!
- Want to create a Zarr?
- Check out the [tools section](#resources-tools)!
- Want to see or download a Zarr?
- Check out the [data section](#resources-data)!
- Want to cite OME-Zarr/NGFF in your work?
- Check out the [publications section](#resources-publications)!

## Have other questions?

Check out the pages below, including the [FAQ](help-desk/index.md#faqs) page.
It is the technical choice for a Next Generation File Format (NGFF) for bioimaging data. For the background, see _Moore, J., Allan, C., Besson, S. et al. OME-NGFF: a next-generation file format for expanding bioimaging data-access strategies. Nature Methods 18, 1496–1498 (2021). [doi:10.1038/s41592-021-01326-w](https://doi.org/10.1038/s41592-021-01326-w)_

```{toctree}
:maxdepth: 1
:hidden:

community/index
contributing/index
Expand Down
14 changes: 8 additions & 6 deletions resources/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
(resources-main)=

# Resources

```{toctree}
Expand All @@ -9,9 +11,9 @@

This section provides resources related to OME-Zarr for users from all experience levels.

* [Data Resources](data/index.md) - A list of publicly available OME-Zarr datasets for testing and exploration.
* [Publications](publications/index.md) - Publications and preprints related to OME-Zarr and NGFF.
* [Tools](tools/index.md) - A list of tools for viewing, reading, writing, converting, validating and processing OME-Zarr data.
* [Learning and Teaching Resources](learning-and-teaching-material/index.md) - A collection of tutorials, guides, slides, notebooks and other materials for OME-Zarr.
* [OME-Zarr Ambassador Toolkit](ambassador-toolkit/index.md) - Slides, talking points and FAQs for confidently giving talks about OME-Zarr.
* [Ecosystem](ecosystem/index.md) - Workflows and data formats that adopt OME-Zarr and build upon it
- [Data Resources](data/index.md) - A list of publicly available OME-Zarr datasets for testing and exploration.
- [Publications](publications/index.md) - Publications and preprints related to OME-Zarr and NGFF.
- [Tools](tools/index.md) - A list of tools for viewing, reading, writing, converting, validating and processing OME-Zarr data.
- [Learning and Teaching Resources](learning-and-teaching-material/index.md) - A collection of tutorials, guides, slides, notebooks and other materials for OME-Zarr.
- [OME-Zarr Ambassador Toolkit](ambassador-toolkit/index.md) - Slides, talking points and FAQs for confidently giving talks about OME-Zarr.
- [Ecosystem](ecosystem/index.md) - Workflows and data formats that adopt OME-Zarr and build upon it
12 changes: 7 additions & 5 deletions rfc/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
(rfc-main)=

# RFCs

```{toctree}
Expand All @@ -16,11 +18,11 @@ and additional details.
The RFC process itself is defined as [RFC-1](1/index.md).
Key sections include:

* [Stakeholders](1/index.md#stakeholders)
* [DRAFT](1/index.md#draft)
* [RFC](1/index.md#rfc)
* [SPEC](1/index.md#spec)
* [Policies](1/index.md#policies)
- [Stakeholders](1/index.md#stakeholders)
- [DRAFT](1/index.md#draft)
- [RFC](1/index.md#rfc)
- [SPEC](1/index.md#spec)
- [Policies](1/index.md#policies)

If you are interested in submitting an RFC, start with the
introduction under ["Proposal"](1/index.md#proposal). Once you
Expand Down
2 changes: 2 additions & 0 deletions specifications/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
(specifications-main)=

# Specifications

OME-Zarr files have standardized metadata (that is the OME portion of "OME-Zarr") - each new version of OME-Zarr files has its own specification. Those specifications are listed below.
Expand Down
Loading