scipp / scipp/ess

Auto-generation of parameters

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

Nobody has claimed this yet.

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

Description

Current it is required to explicitly create a parameter for each workflow input that is to be displayed in a widget. We should explore if we can fall back to auto-generating this. This would make the widget usable with less need for customization, at least for basic parameter types.

The approach would likely require inspecting the type of the workflow input, which can map to a corresponding parameter type. This will work fine for basics such as int, float, str, bool, etc., but not for types that alias some generic containers such as scipp.Variable.

I think it is probably useful to implement this anyway: Even if the solution does not work in all cases it will nevertheless reduce the need for boilerplate code (both in our own technique packages as well as for users writing their own workflows).

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

No files or tests are named. Start by locating the workflow widget code that currently requires explicit parameters, then trace how workflow input types are inspected and mapped to parameter types. Done should include automatic parameters for basic types such as int, float, str, and bool, with behavior for unsupported container-like types defined and covered by tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.