General user stories for OME-Zarr (tied or not to particular RFCs)

Open
#650 22 comments 1 reaction 1 assignee View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
python
Domain
documentation

Research direction

This is an open collection thread, not a single task: contributors add user stories in the suggested format (title, as a, I want, so that, example data). Start by reading the RFC index linked from the issue and the existing discussion to avoid duplicating stories. Done means your story is posted in the agreed format with a concrete example dataset where one exists.

Written by the indexing model from the issue text.

Description

We welcome anyone to contribute user stories for OME-Zarr in this issue. Even if something is currently doable in NGFF, the user story is welcome, as we may find better ways to do it in the future.

Some works in progress, in the form of RFCs, may have their own way of tracking user stories.
You don't need to figure out the right place. Just put your user story here and we will sort/organize

I suggest the format:

User story - [title]
As a [type of user],
I want [to encode X, to process data in Y way, to save Z metadata],
So that [the biological/scientific/technical problem it solves ]
Example data/paper/article [if available]: [https://example.org]

But you can of course add more details

For example:

User story - Metadata to particular timestamps
As a bioimage analyst,
I want to save metadata tied to particular timestamps,
So we can correctly process data acquired in non-uniform sampling protocols, used in e.g. long time lapses and smart microscopy setups
Example data: https://zenodo.org/records/22078388

Dominant language
Python
Stars
180
Forks
81
Avg merge
5d 7h
Merged PRs (30d)
9

Getting set up

  • No Dockerfile or Docker Compose file
  • No pull request template
  • Read the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ome/ngff

All issues in ome/ngff

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.