A run can fill more than one file role

Aperta
  • Qualcosa non va?
#153 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
python
Ambito
api, backend

Direzione di ricerca

Read files.py for Selector.matches, checks.py for submit validation, and docs/requirements/sans.md plus docs/requirements/data.md for the requirements and open design question. Compare the two role options against filtering in client.files.list, form listings, and rule selectors; confirm the approach with the NICOS and SciCat constraints before implementation. Done means a run with two roles is accepted for each role at submit and in all the listed selectors.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

A file has one role in its metadata, and Selector.matches compares it with the marker's value by equality (files.py). The backend refuses a file that does not match at submit (checks.py), and rules and form pickers filter the same way. So a run can fill only fields of one role.

Real data do not fit this. In the esssans LoKI tutorial, run 60392 is both the can transmission run and the empty-beam run (ess.loki.data.loki_tutorial_run_60392):

class IofQParams(BaseModel):
    can_transmission: TransmissionRunFile   # File(role='transmission')
    empty_beam: EmptyBeamRunFile            # File(role='empty_beam')

client.submit(IOFQ, params={'can_transmission': file(run=60392),  # fits if the table says role='transmission'
                            'empty_beam': file(run=60392), ...})  # then this is refused

docs/requirements/sans.md records that one run can fill several roles. #143 deferred list-valued roles.

Workaround

The LoKI specs of #24 type empty_beam as RunFile, which accepts a raw file of any role. The request then goes through, but a form offers every run for that field, and a file source's role plays no part in choosing the empty beam.

Options
  1. Roles as a set on the file's side. The metadata hold role=['transmission', 'empty_beam'], and a selector matches if the marker's role is in the set. The File marker keeps one role. Small change, but Selector.matches, the form listing, and rules need to agree on it, and every consumer of metadata['role'] sees a list.
  2. Metadata describe the measurement, and a role is a use. A file says what was measured: is there a sample, a can, is the transmission monitor in the beam. A field's marker selects on those facts. A 60392-like run then fits both fields without saying so. This fits the Open question in docs/requirements/data.md (how files or the catalogue say what role a run plays), but the vocabulary depends on what ESS files will hold.

Option 1 is enough for a table a person fills (#24, #131). Automatic reduction (#151) needs the answer from the NICOS and SciCat teams, which may favour option 2.

Tests

A run with two roles fits fields of each role, at submit, in client.files.list, in a form's listing, and in a rule's selector.

Lingua principale
Python
Stelle
0
Fork
1
Merge medio
15h 40m
PR unite (30g)
59

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di scipp/essapps

Tutte le issue di scipp/essapps

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.