scipp / scipp/ess

[essdiffraction, DREAM, BEER] Comments on Sciline workflow

Open
#619 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Comments shared with @nvaytet and @jokasimr
Posted here as records

  • it would be useful to have a more compact display of the workflow, which could be interactive and display additional info by clicking on parts of the workflow (like details about d-spacing, docstrings about the method, coordinates of the output, link to the documentation...)
  • it would also be useful to know which settings are required or optional.
  • are you planning to have "forks" in the workflows? For example by giving the option to convert to d-spacing or Q, saving as xye or CIF, stripping Vanadium peaks or not...

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

Start by reviewing the Sciline workflow usage in the essdiffraction, DREAM, and BEER workflows. The issue lists possible interactive displays, required or optional settings, and workflow forks, but names no files, entry points, tests, or acceptance criteria, so the desired scope must be clarified before implementation.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.