Consolidate workflow specifications, parameter models, and metadata mechanisms
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 1
- Forks
- 3
- Merge medio
- 2 d 11 h
- PR fusionados (30 d)
- 17
Descripción
Motivation
Avoid duplication, unify descriptions, etc. for UI generation and user info.
Relevant bits to be consolidated
- https://github.com/scipp/ess/blob/main/packages/essnmx/src/ess/nmx/configurations.py
- https://github.com/scipp/esslivedata/blob/main/src/ess/livedata/parameter_models.py
- Trimmed-down version of https://github.com/scipp/esslivedata/blob/aaf21dcf92a4df4e2b8b1e7278da96e02cd647b0/src/ess/livedata/config/workflow_spec.py#L246-L252
Probably not for v1: - Instrument-specific metadata (https://github.com/scipp/esslivedata/blob/aaf21dcf92a4df4e2b8b1e7278da96e02cd647b0/src/ess/livedata/config/instruments/loki/specs.py#L182-L227 )
- Models for inputs and outputs (example: https://github.com/scipp/esslivedata/blob/aaf21dcf92a4df4e2b8b1e7278da96e02cd647b0/src/ess/livedata/config/instruments/loki/specs.py#L120-L170)
Maybe start by writing an ADR about a minimal solution so we can have a consensus about scope and shape?
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.
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Lee scipp/esslivedata#889 y especialmente el comentario referenciado antes de comparar configurations.py, parameter_models.py y la sección recortada de workflow_spec.py. Empieza redactando un ADR para una consolidación mínima de v1, excluyendo explícitamente los metadatos específicos del instrumento y los modelos de entrada/salida. Se considerará terminado cuando el alcance y la estructura cuenten con consenso antes de comenzar la implementación.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- backend
- Tipo de issue
- Refactorización
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Tranquilo
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 35/100