scipp / scipp/ess

NeXus workflow: Why the name `FrameMonitor`?

Open
#70 3 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

Stupid question: where did the name "frame monitor" come from?
In the nexus types, we have FrameMonitor0-3, but a more common name (at least when talking to scientists) seems to be "beam monitor".

Should we rename FrameMonitor to BeamMonitor?

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 locating the NeXus type definitions for FrameMonitor0-3 and review the project’s terminology and relevant scientific usage. Confirm whether BeamMonitor is the appropriate name, then update the affected naming consistently once the decision is made.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.