scipp / scipp/ess

Consolidate workflow specifications, parameter models, and metadata mechanisms

Open
#653 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1
Forks
3
Avg merge
2d 11h
Merged PRs (30d)
17

Description

Motivation

Avoid duplication, unify descriptions, etc. for UI generation and user info.

Relevant bits to be consolidated

Mandatory reading

I have previously done most of this analysis in scipp/esslivedata#889. Make sure to read it and in particular https://github.com/scipp/esslivedata/issues/889#issuecomment-4311180193 -- the attempt to consolidate everything ended up getting out of hand and blocked the entire work.

Contributor guide

Open 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.

Research direction

Read scipp/esslivedata#889 and especially the referenced comment before comparing configurations.py, parameter_models.py, and the trimmed workflow_spec.py section. Start by drafting an ADR for a minimal v1 consolidation, explicitly excluding instrument-specific metadata and input/output models. Done means the scope and shape have consensus before implementation begins.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.