Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Run Feedback Views #554

Open
wants to merge 5 commits into
base: next
Choose a base branch
from
Open

Run Feedback Views #554

wants to merge 5 commits into from

Conversation

darshdinger
Copy link
Contributor

@darshdinger darshdinger commented Feb 27, 2025

Description of work

This update introduces a Run Feedback View in SNAPRed, which provides real-time feedback about the selected run(s) in each workflow. The goal is to enhance user awareness by displaying key run metadata—such as State ID and Run Title—in an uneditable format within the first tab of each workflow. This ensures that users can verify their selections without needing to cross-reference external sources.

The feature is integrated into all primary workflows:

  • DiffCal Workflow: Displays the State ID and Run Title for the selected run.
  • NormCal Workflow: Displays the State ID and Run Title for the vanadium run only.
  • Reduction Workflow: Displays the State ID and Run Title of the first run in the list.

Explanation of work

The implementation consists of backend logic to retrieve and store run metadata, along with UI updates to display this information dynamically.

  1. Data Retrieval & Storage
  • Extracts State ID and Run Title from the selected run(s).
  • Stores this information in a structured manner, ensuring consistency across workflows.
  1. UI Integration
  • In DiffCal and NormCal, the run information is displayed below the run entry field.
  • In Reduction, it appears next to the entry in the run list.
  • The fields are uneditable, ensuring the displayed information remains accurate and unchanged.

To test

Dev testing

Please ensure all pytests and integration tests pass. In order to test, please manually regression test all of the workflows in order to insure this feature functions.

CIS testing

Same as above.

Link to EWM item

EWM # 8152

Verification

  • the author has read the EWM story and acceptance critera
  • the reviewer has read the EWM story and acceptance criteria
  • the reviewer certifies the acceptance criteria below reflect the criteria in EWM

Acceptance Criteria

This list is for ease of reference, and does not replace reading the EWM story as part of the review. Verify this list matches the EWM story before reviewing.

  • SNAPRed is fully functional as before
  • in diffcal (just one run selected): [show stateID and run title, To be displayed in the first tab, under run entry field upon entry of run number (uneditable)]
  • n normcal (two runs selected. must be from same state): [show stateID and run title from vanadium run only, To be displayed in the first tab, under run entry field upon entry of run number (uneditable)]
  • in reduction (potentially many runs from different states): [show stateID and run title, To be displayed in the first tab, next to entry in run list (uneditable)]

@darshdinger darshdinger marked this pull request as ready for review February 27, 2025 16:06
@neutrons neutrons deleted a comment from codecov bot Feb 27, 2025
Copy link

codecov bot commented Feb 27, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.11%. Comparing base (6fdb95d) to head (ed1dd95).

Additional details and impacted files
@@            Coverage Diff             @@
##             next     #554      +/-   ##
==========================================
+ Coverage   96.10%   96.11%   +0.01%     
==========================================
  Files          71       71              
  Lines        5466     5482      +16     
==========================================
+ Hits         5253     5269      +16     
  Misses        213      213              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant