Next-generation file format (NGFF) specifications for storing bioimaging data in the cloud.
Specifications are written in markdown, or technically bikeshed -- a markdown document, with special extensions understood by the bikeshed tool. The bikeshed tool is run on-commit via the spec-prod github action, generating the familiar "spec looking" ReSpec format. ReSpec is just html with a javascript ReSpec library.
Specification files end with the .bs file extension. The github action runs on commit to automatically convert to respec/html, via bikeshed.
Commits on GitHub can be viewed using web services from the W3C:
latest/index.bs
latest/index.bs
For each top-level metadata key of the OME-NGFF specification, JSON schemas are maintained
for each version of the specification and stored under $VERSION/schemas/
or latest/schemas/
.
Tests validating these schemas must be implemented to follow principles of the
JSON schema test suite
and stored under $VERSION/tests/
or latest/tests/
to allow their execution on each CI build.
All official example snippets must also be extracted and managed as separate JSON files under
$VERSION/examples/
or latest/examples/
, validated by the appropriate schema by adding a
.config.json
file specifying the JSON schema to use and included in the
specification document using the
include-code directive.
The official OME-NGFF JSON schemas are published under
https://ngff.openmicroscopy.org/
latest/index.bs
to $VERSION/index.bs
latest/copyright.include
to $VERSION/copyright.include
$VERSION
ed file
Status: w3c/CG-FINAL
URL:
Status Text:
: "This is the $VERSION release of this specification.
Migration scripts will be provided between numbered versions. Data written with the latest version
(an "editor's draft") will not necessarily be supported."$VERSION
ed file
Please see https://ngff.openmicroscopy.org/latest#citing for the latest citation.