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

Rawdata explorer widget #34691

Draft
wants to merge 195 commits into
base: main
Choose a base branch
from
Draft

Conversation

MathieuTillet
Copy link
Contributor

@MathieuTillet MathieuTillet commented Nov 9, 2022

Description of work.
This PR introduces the Raw Data Explorer widget, designed to browse raw data files in a streamlined way.

The widget appears tiled under the workspace list, and allow the user to select a directory and browse starting from there. Every time they click on a file, it is loaded and displayed in what is supposed to be the most appropriate way. Only one preview can exist at a time, so unused ones are closed as soon as they are not necessary.

By holding the control key, the user can accumulate different files, effectively summing them. Un-accumulating is not supported.

When the total memory used goes over 80% by Mantid count, unused workspaces are deleted until the memory goes down to a more reasonable value, starting by the ones that have not been interacted with for the longest time.

Testing this widget mainly consists in using it. It is supposed to support all the raw data that Mantid can load, or handle gracefully errors. In particular, since it has been developed exclusively on Ubuntu, checking that Qt behaves on other system would be good.

Attached RDExp.pdf is the requirement document, which might be useful for reference of expected behaviors and features.

To test:

  1. Open workbench.
  2. Find the Raw data explorer widget, by default it should be placed behind the Workspaces widget.
  3. Find some data to visualize: UnitTest/ILL data would have different types of plots from 1D plot, 2D plot, InstrumentView, while other instruments from outside ILL would be visualized in the InstrumentView widget at the moment.
  4. You should be able to navigate the tree with keyboard and each time you change a file, a new visualization should be displayed (or an informative error dialog).
  5. Try to accumulate data: select a number of files while holding the Ctrl key. Displayed data should be added in the visualization.

Fixes #29249 .

Release note and documentation added.


Reviewer

Please comment on the following (full description):

Code Review
  • Is the code of an acceptable quality?
  • Does the code conform to the coding standards?
  • Are the unit tests small and test the class in isolation?
  • If there is GUI work does it follow the GUI standards?
  • If there are changes in the release notes then do they describe the changes appropriately?
  • Are the release notes saved in a separate file, using Issue or PR number for file name and in the correct location?
Functional Tests
  • Do changes function as described? Add comments below that describe the tests performed?
  • Do the changes handle unexpected situations, e.g. bad input?
  • Has the relevant (user and developer) documentation been added/updated?

Does everything look good? Mark the review as Approve. A member of @mantidproject/gatekeepers will take care of it.

@MathieuTillet MathieuTillet added Framework Issues and pull requests related to components in the Framework GUI Issues and pull requests specific to the Mantid Workbench GUI. ILL Team Issues and pull requests managed by the ILL development team labels Nov 9, 2022
@MathieuTillet MathieuTillet force-pushed the 29249_raw_data_explorer_widget branch from e796771 to 05bb78e Compare November 9, 2022 12:53
@github-actions
Copy link

github-actions bot commented Nov 9, 2022

👋 Hi, @MathieuTillet,

Conflicts have been detected against the base branch. Please rebase your branch against the base branch.


This message is automatically generated by prince-chrismc/label-merge-conflicts-action so don't hesitate to report issues/improvements there.

@github-actions github-actions bot added the Has Conflicts Used by the bot to label pull requests that have conflicts label Nov 9, 2022
MathieuTillet and others added 24 commits November 10, 2022 08:45
In the rdexp widget, add the file management and a very rudimentary
display mecanism.
This is a simple tag that indicates if an instrument is 1D or 2D.
Only for some ILL instruments for which all the info are already here.
In the raw data explorer, most of the display types are now supported.
Slice Viewer and Instrument view needs polishing to manage their
behaviour when closing.
The view sends a signal when it is closed through the close button. This
signals is caught by the presenter to remove the instrument viewer from
the manager.
@github-actions github-actions bot removed the Has Conflicts Used by the bot to label pull requests that have conflicts label May 11, 2023
@perenon perenon modified the milestones: Release 6.7, Release 6.8 May 17, 2023
@perenon perenon modified the milestones: Release 6.8, Release 6.9 Sep 4, 2023
Copy link

github-actions bot commented Dec 4, 2023

This pull request has been automatically marked as stale because it has not had activity in 3 months. It will be closed in 7 days if no further activity occurs.
Allowing pull requests to close as stale helps us filter out old work that is no longer relevant and helps developers focus on reviewing current work.
All pull requests closed by this bot act like normal pull requests; they can be searched for, commented on or reopened at any point.
If these changes are still relevant then please comment and tag @mantidproject/gatekeepers to highlight that it needs to have a reviewer assigned.

@github-actions github-actions bot added the Stale This label is automatically applied to issues that are automatically closed by the stale bot label Dec 4, 2023
@perenon
Copy link
Contributor

perenon commented Dec 6, 2023

Up

@github-actions github-actions bot removed the Stale This label is automatically applied to issues that are automatically closed by the stale bot label Dec 7, 2023
@perenon perenon marked this pull request as draft December 8, 2023 15:24
@perenon perenon modified the milestones: Release 6.9, Release 6.10 Jan 11, 2024
Copy link

This pull request has been automatically marked as stale because it has not had activity in 3 months. It will be closed in 7 days if no further activity occurs.
Allowing pull requests to close as stale helps us filter out old work that is no longer relevant and helps developers focus on reviewing current work.
All pull requests closed by this bot act like normal pull requests; they can be searched for, commented on or reopened at any point.
If these changes are still relevant then please comment and tag @mantidproject/gatekeepers to highlight that it needs to have a reviewer assigned.

@github-actions github-actions bot added the Stale This label is automatically applied to issues that are automatically closed by the stale bot label Apr 11, 2024
@perenon
Copy link
Contributor

perenon commented Apr 16, 2024

(Re-)Up

@github-actions github-actions bot removed the Stale This label is automatically applied to issues that are automatically closed by the stale bot label Apr 17, 2024
@sf1919 sf1919 modified the milestones: Release 6.10, Release 6.11 May 9, 2024
Copy link

👋 Hi, @MathieuTillet,

Conflicts have been detected against the base branch. Please rebase your branch against the base branch.

@github-actions github-actions bot added the Has Conflicts Used by the bot to label pull requests that have conflicts label Jul 25, 2024
@perenon perenon removed this from the Release 6.11 milestone Aug 28, 2024
Copy link

This pull request has been automatically marked as stale because it has not had activity in 3 months. It will be closed in 7 days if no further activity occurs.
Allowing pull requests to close as stale helps us filter out old work that is no longer relevant and helps developers focus on reviewing current work.
All pull requests closed by this bot act like normal pull requests; they can be searched for, commented on or reopened at any point.
If these changes are still relevant then please comment and tag @mantidproject/gatekeepers to highlight that it needs to have a reviewer assigned.

@github-actions github-actions bot added the Stale This label is automatically applied to issues that are automatically closed by the stale bot label Nov 27, 2024
@perenon
Copy link
Contributor

perenon commented Nov 27, 2024

(Yet another) up

@github-actions github-actions bot removed the Stale This label is automatically applied to issues that are automatically closed by the stale bot label Nov 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Framework Issues and pull requests related to components in the Framework GUI Issues and pull requests specific to the Mantid Workbench GUI. Has Conflicts Used by the bot to label pull requests that have conflicts ILL Team Issues and pull requests managed by the ILL development team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Raw Data Explorer Widget
9 participants