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

Redesign summary view #1044

Merged
merged 15 commits into from
Dec 30, 2024
Merged

Conversation

edan-bainglass
Copy link
Member

@edan-bainglass edan-bainglass commented Dec 28, 2024

This PR is one in several that will address #1042

Here, I introduce a bullet list alternative format for the summary report (no actual bullets). The format is defined in qeapp.yml as summary_format: list and can be overridden by the user in a config file (see #1007 for info regarding file). summary_format takes list or table.

I also adjust the style such that the data download widget is to the right of the summary instead of below. This is true for either selected format.

Lastly, I add "Workflow properties" and "Structure properties" sections to the summary.


image

image

@edan-bainglass
Copy link
Member Author

If anyone has an older container (with an older AiiDA version, say, 2.5ish), can you please verify that you still get the notification regarding the unavailability of the raw data download feature?

Copy link

codecov bot commented Dec 28, 2024

Codecov Report

Attention: Patch coverage is 68.31683% with 32 lines in your changes missing coverage. Please review.

Project coverage is 67.58%. Comparing base (68cdb8d) to head (c6e1725).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
..._qe/app/result/components/summary/download_data.py 16.66% 20 Missing ⚠️
src/aiidalab_qe/common/time.py 72.22% 5 Missing ⚠️
...idalab_qe/app/result/components/summary/summary.py 84.00% 4 Missing ⚠️
...aiidalab_qe/app/result/components/summary/model.py 90.90% 3 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1044      +/-   ##
==========================================
- Coverage   67.65%   67.58%   -0.07%     
==========================================
  Files         117      118       +1     
  Lines        6498     6543      +45     
==========================================
+ Hits         4396     4422      +26     
- Misses       2102     2121      +19     
Flag Coverage Δ
python-3.11 67.58% <68.31%> (-0.07%) ⬇️
python-3.9 67.60% <68.31%> (-0.07%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@AndresOrtegaGuerrero
Copy link
Member

why dont you try with from IPython.core.display import HTML and create the tables , like that you have more flexibility in the appearance.

Also since the tab of picking the settings was Basic settings, you should keep the same instead of using Main settings

@edan-bainglass
Copy link
Member Author

why dont you try with from IPython.core.display import HTML and create the tables , like that you have more flexibility in the appearance.

No idea what you're referring to 😅

Also since the tab of picking the settings was Basic settings, you should keep the same instead of using Main settings

This was a specific request by Giovanni. See issue.

@AndresOrtegaGuerrero
Copy link
Member

AndresOrtegaGuerrero commented Dec 28, 2024

why dont you try with from IPython.core.display import HTML and create the tables , like that you have more flexibility in the appearance.

No idea what you're referring to 😅

You can make an HTML object and create a table and to display it , it has better visuals than the ipywidget.HTML.
The table gave this kind of separation that was nice , plus a highlight , but indeed they were to big the cell size.
My opinion of the visuals is that is a lil too simple , plus everything looks to close to each other.

Also since the tab of picking the settings was Basic settings, you should keep the same instead of using Main settings

This was a specific request by Giovanni. See issue.

Ok , then we should keep it consistent in the configuration step , and name it main settings as well (instead of basic)

@AndresOrtegaGuerrero
Copy link
Member

@edan-bainglass I can confirm you that the notification for aiida 2.5 works
image

@edan-bainglass
Copy link
Member Author

Thanks @AndresOrtegaGuerrero 🙏

@edan-bainglass
Copy link
Member Author

edan-bainglass commented Dec 29, 2024

@giovannipizzi @cpignedoli alternative...

image

Both list and table are now valid choices for a new summary_format configuration key, which thanks to #1007, is now user-configurable via a local config file. Currently defaulting to list, though the table view is quite clean in my opinion (suggested by @AndresOrtegaGuerrero).

Also, "Main settings" is inconsistent with "Basic settings". Best we uniform this. Do you agree, and if so, preference?

@giovannipizzi
Copy link
Member

Thanks! Both are good, table is OK as the dark color is not too dark/prominent. But as the list might get longer, maybe the list is OK. I agree with uniforming basic/main,maybe "main" is better but both are are ok.

@edan-bainglass
Copy link
Member Author

edan-bainglass commented Dec 29, 2024

Thanks! Both are good, table is OK as the dark color is not too dark/prominent. But as the list might get longer, maybe the list is OK. I agree with uniforming basic/main,maybe "main" is better but both are are ok.

Okay then. Leaving list as the default. Will also reduce the vertical padding in the table a bit more. And I think I'll stick to "basic". Thanks!


For reference

image

@edan-bainglass
Copy link
Member Author

Adding more info requested in #1042

image

and

image

@edan-bainglass
Copy link
Member Author

@AndresOrtegaGuerrero could you please review once more? 🙏

@AndresOrtegaGuerrero
Copy link
Member

@edan-bainglass Thank you! In my test everything works. I did notice an issue I mentioned in #1045, where we sometimes fail to indicate whether the full workflow completed successfully. However, I’m thinking this might not be the right place to address it—what do you think?

@AndresOrtegaGuerrero
Copy link
Member

Just dont forget to solve the conflict

Copy link
Member

@AndresOrtegaGuerrero AndresOrtegaGuerrero left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thank you @edan-bainglass

@AndresOrtegaGuerrero
Copy link
Member

@edan-bainglass It just crossed my mind now, should we report the properties computed ?

@edan-bainglass
Copy link
Member Author

@edan-bainglass Thank you! In my test everything works. I did notice an issue I mentioned in #1045, where we sometimes fail to indicate whether the full workflow completed successfully. However, I’m thinking this might not be the right place to address it—what do you think?

Indeed, unrelated. Thanks for opening the issue.

@edan-bainglass
Copy link
Member Author

@edan-bainglass It just crossed my mind now, should we report the properties computed ?

I suppose so? Doesn't hurt. I'll add it 👍

@edan-bainglass
Copy link
Member Author

@edan-bainglass It just crossed my mind now, should we report the properties computed ?

I suppose so? Doesn't hurt. I'll add it 👍

@AndresOrtegaGuerrero not sure where and how to best represent the computed properties. For now, I'll merge without it. Let's discuss and PR this later.

@edan-bainglass edan-bainglass removed the request for review from unkcpz December 30, 2024 17:07
@edan-bainglass edan-bainglass merged commit 452d60d into aiidalab:main Dec 30, 2024
8 checks passed
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.

3 participants