Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 0 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@ var/
*.egg-info/
.installed.cfg
*.egg
*_version.py

# PyInstaller
# Usually these files are written by a python script from a template
Expand Down Expand Up @@ -91,9 +90,6 @@ target/
# OS
.DS_Store

# written by setuptools_scm
*/_version.py

# PyBuilder
.idea
venv/
88 changes: 88 additions & 0 deletions ngff_spec/CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
cff-version: 1.2.0
message: Please cite the following works when using this project.
abstract: >-
A growing community is constructing a next-generation file format (NGFF) for
bioimaging to overcome problems of scalability and heterogeneity. Organized by
the Open Microscopy Environment (OME), individuals and institutes across
diverse modalities facing these problems have designed a format specification
process (OME-NGFF) to address these needs. Those community members have built
the format itself – OME-Zarr – along with tools and data resources available
today to increase FAIR access and remove barriers in the scientific process.
The current momentum offers an opportunity to unify a key component of the
bioimaging domain — the file format that underlies so many personal,
institutional, and global data management and analysis tasks.
title: Next-generation file format specification
authors:
- family-names: NGFF-community
given-names: ''
identifiers:
- type: doi
value: 10.1038/s41592-021-01326-w
description: Original Nature Methods article (2021)
- type: doi
value: 10.1101/2023.02.17.528834v2
description: OME-Zarr preprint (2023)
keywords:
- FAIR
- community
- bioimaging
- data
- cloud
- format
license: CC-BY-4.0
url: https://ngff.openmicroscopy.org
repository: https://github.com/ome/ngff-spec
preferred-citation:
type: article
doi: 10.1038/s41592-021-01326-w
journal: Nature Methods
month: 11
start: 1496
end: 1498
title: >-
OME-NGFF: a next-generation file format for expanding bioimaging data-access
strategies
issue: 12
volume: 18
year: 2021
authors:
- given-names: Josh
family-names: Moore
orcid: https://orcid.org/0000-0003-4028-811X
- given-names: Chris
family-names: Allan
- given-names: Sébastien
family-names: Besson
orcid: https://orcid.org/0000-0001-8783-1429
- given-names: Jean-Marie
family-names: Burel
orcid: https://orcid.org/0000-0002-1789-1861
- given-names: Erin
family-names: Diel
orcid: https://orcid.org/0000-0003-2526-3512
- given-names: David
family-names: Gault
- given-names: Kevin
family-names: Kozlowski
- given-names: Dominik
family-names: Lindner
orcid: https://orcid.org/0000-0001-8038-1250
- given-names: Melissa
family-names: Linkert
- given-names: Trevor
family-names: Manz
orcid: https://orcid.org/0000-0001-7694-5164
- given-names: Will
family-names: Moore
orcid: https://orcid.org/0000-0002-7264-8338
- given-names: Constantin
family-names: Pape
orcid: https://orcid.org/0000-0001-6562-7187
- given-names: Christian
family-names: Tischer
orcid: https://orcid.org/0000-0003-4105-1990
- given-names: Jason R.
family-names: Swedlow
orcid: https://orcid.org/0000-0002-2198-1958
type: software
repository-code: https://github.com/ome/ngff
1 change: 1 addition & 0 deletions ngff_spec/_version.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
__version__ = '0.6.dev1'
6 changes: 4 additions & 2 deletions ngff_spec/citing.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
Citing
======
---
title: Citing
author: ""
---
(citing)=

[Next-generation file format (NGFF) specifications for storing bioimaging data in the cloud.](https://ngff.openmicroscopy.org/0.4)
Expand Down
36 changes: 36 additions & 0 deletions ngff_spec/contribute.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
author: ""
---
# Contribution guide

Contributions to the spec text, examples and schemas are highly welcome
Expand Down Expand Up @@ -28,6 +31,39 @@ jupyter book build ngff_spec

You'll find the built webpages under `_build/html`.

## First contribution

If you haven't contributed to the spec before,
please add yourself as an author in the `ngff_spec/myst.yml` metadata file.
This should look like this, for example:

```yaml
- name: John A. Doe
id: jdoe
orcid: xxxx-xxxx-xxxx-xxxx
github: jdoe
affiliations:
- id: key
institution: ICSLDJ University
city: Doeburg
ror: https://ror.org/....
- name: Jane Doe
affiliations: key
```

For more information see [myst documentation on author formatting](https://mystmd.org/guide/frontmatter#frontmatter-authors).

When you submit your first PR,
make sure to rebuild the `CITATION.cff` file in the root of this repository.
To do so, run the following command:

```bash
cd ngff_spec/ && jupyter book build --cff
```

Copy the generated `CITATION.cff` file from `ngff_spec/CITATION.cff` to the root of this repository
and submit it along with your PR.

### Text format

Contributions should conform to [Semantic Line Breaks (SemBr)](https://sembr.org/),
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"multiscales": [
{
"version": "0.6dev2",
"version": "0.6.dev2",
"name": "example",
"coordinateSystems" : [
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"node_type": "group",
"attributes": {
"ome": {
"version": "0.6dev2",
"version": "0.6.dev2",
"multiscales": [
{
"coordinateSystems": [
Expand Down
88 changes: 86 additions & 2 deletions ngff_spec/myst.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,96 @@ project:
- format: pdf
template: plain_latex_book
output: exports/book.pdf
- format: cff
type: software
identifiers:
- type: doi
value: 10.1038/s41592-021-01326-w
description: Original Nature Methods article (2021)
- type: doi
value: 10.1101/2023.02.17.528834v2
description: OME-Zarr preprint (2023)
repository-code: 'https://github.com/ome/ngff'
url: 'https://ngff.openmicroscopy.org'
abstract: >-
A growing community is constructing a next-generation file
format (NGFF) for bioimaging to overcome problems of
scalability and heterogeneity. Organized by the Open
Microscopy Environment (OME), individuals and institutes
across diverse modalities facing these problems have
designed a format specification process (OME-NGFF) to
address these needs. Those community members have built
the format itself – OME-Zarr – along with tools and data
resources available today to increase FAIR access and
remove barriers in the scientific process. The current
momentum offers an opportunity to unify a key component of
the bioimaging domain — the file format that underlies so
many personal, institutional, and global data management
and analysis tasks.
keywords:
- FAIR
- community
- bioimaging
- data
- cloud
- format
license: CC-BY-4.0
preferred-citation:
type: article
doi: "10.1038/s41592-021-01326-w"
journal: "Nature Methods"
month: 11
start: 1496
end: 1498
title: "OME-NGFF: a next-generation file format for expanding bioimaging data-access strategies"
issue: 12
volume: 18
year: 2021
authors:
- given-names: "Josh"
family-names: "Moore"
orcid: "https://orcid.org/0000-0003-4028-811X"
- given-names: "Chris"
family-names: "Allan"
- given-names: "Sébastien"
family-names: "Besson"
orcid: "https://orcid.org/0000-0001-8783-1429"
- given-names: "Jean-Marie"
family-names: "Burel"
orcid: "https://orcid.org/0000-0002-1789-1861"
- given-names: "Erin"
family-names: "Diel"
orcid: "https://orcid.org/0000-0003-2526-3512"
- given-names: "David"
family-names: "Gault"
- given-names: "Kevin"
family-names: "Kozlowski"
- given-names: "Dominik"
family-names: "Lindner"
orcid: "https://orcid.org/0000-0001-8038-1250"
- given-names: "Melissa"
family-names: "Linkert"
- given-names: "Trevor"
family-names: "Manz"
orcid: "https://orcid.org/0000-0001-7694-5164"
- given-names: "Will"
family-names: "Moore"
orcid: "https://orcid.org/0000-0002-7264-8338"
- given-names: "Constantin"
family-names: "Pape"
orcid: "https://orcid.org/0000-0001-6562-7187"
- given-names: "Christian"
family-names: "Tischer"
orcid: "https://orcid.org/0000-0003-4105-1990"
- given-names: "Jason R."
family-names: "Swedlow"
orcid: "https://orcid.org/0000-0002-2198-1958"
toc:
- file: specification.md
- file: examples.md
- file: _generated/examples.md
children:
- pattern: _generated/examples/*
- file: schemas.md
- file: _generated/schemas.md
children:
- pattern: _generated/schemas/markdown/*
- file: contribute.md
Expand Down
Loading