Grotrian diagram IPyWidget functionality

[AyushiDaksh]

:pencil: Description

This PR is part of the Grotrian Diagram project, part of Google Summer of Code 2023. Project description and related PRs/Issues can be found on the project page.

This PR aims to integrate the Plotly plot with IPyWidgets menus. In other words, this PR adds functionality to the Grotrian Diagram widget.

Type: :rocket: feature

Also, link issues affected by this pull request by using the keywords: close, closes, closed, fix, fixes, fixed, resolve, resolves or resolved.

:pushpin: Resources

Project Link: https://github.com/users/AyushiDaksh/projects/1 Idea Link: https://tardis-sn.github.io/gsoc_2023/ideas/ GSoC Project Link: https://summerofcode.withgoogle.com/programs/2023/projects/HxymUMRe

:vertical_traffic_light: Testing

How did you test these changes?

• [ ] Testing pipeline
• [ ] Other method (describe)
• [ ] My changes can't be tested (explain why)

:ballot_box_with_check: Checklist

• [ ] I requested two reviewers for this pull request
• [ ] I updated the documentation according to my changes
• [ ] I built the documentation by applying the build_docs label

Note: If you are not allowed to perform any of these actions, ping (@) a contributor.

[review-notebook-app[bot]]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[codecov[bot]]

Codecov Report

Attention: Patch coverage is 12.38095% with 92 lines in your changes are missing coverage. Please review.

Project coverage is 68.89%. Comparing base (5bca272) to head (e6aed1e).

:exclamation: Current head e6aed1e differs from pull request most recent head d71c714. Consider uploading reports for the commit d71c714 to get more accurate results

Files	Patch %	Lines
tardis/visualization/widgets/grotrian.py	12.38%	92 Missing :warning:

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2328      +/-   ##
==========================================
+ Coverage   67.51%   68.89%   +1.37%     
==========================================
  Files         170      165       -5     
  Lines       14228    14081     -147     
==========================================
+ Hits         9606     9701      +95     
+ Misses       4622     4380     -242     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

[andrewfullard]

Can this be merged?

[jamesgillanders]

@MarkMageeAstro @jamesgillanders @aoifeboyle(?) to review/test this and make a decision to merge or update

[jamesgillanders]

@AyushiDaksh we are keen to merge this PR -- can you please rebase it?

[AyushiDaksh]

@MarkMageeAstro @jamesgillanders Sorry I somehow saw the comments now. Yes we're keen on merging this. I'll rebase this branch and make the requested changes today

[MarkMageeAstro]

Any luck with this @AyushiDaksh?

[MarkMageeAstro]

@AyushiDaksh can you let us know if you're still interested in this?

[AyushiDaksh]

@MarkMageeAstro Sorry I moved to a new city this month so the last couple of weeks were really busy. I have started work on this now, will wrap it up this weekend

[AyushiDaksh]

Minor changes to documentation. Should be good to merge after rebasing. Is that Grotrian mockup notebook still necessary?

I have changed the docs according to the comments and rebased the branch. The mockup notebook helps the user learn to use the tool quickly. I would suggest keeping it.

@MarkMageeAstro @jamesgillanders

[tardis-bot]

*beep* *bop*

Hi, human.

The docs workflow has succeeded :heavy_check_mark:

Click here to see your results.

[AyushiDaksh]

@MarkMageeAstro

One minor correction to documentation.

Somehow I'm not able to see your comment. Can you point me to where you need the correction?

Also the mockup notebook didn't show any figures for mean on ReviewNB. Can you generate it again?

Since the Grotrian Widget is a dynamic widget, it doesn't persist in the notebook when it gets saved. This is the same reason why other dynamic widgets don't show up on our documentation page (and we have to resort to GIFs instead).

[MarkMageeAstro]

@MarkMageeAstro

One minor correction to documentation.

Somehow I'm not able to see your comment. Can you point me to where you need the correction?

Hmm, I can't find it either. Must not have been that important. I did spot one other small thing when looking for it thoguh, sorry.

Also the mockup notebook didn't show any figures for mean on ReviewNB. Can you generate it again?

Since the Grotrian Widget is a dynamic widget, it doesn't persist in the notebook when it gets saved. This is the same reason why other dynamic widgets don't show up on our documentation page (and we have to resort to GIFs instead).

Ah, I must have been confused because there were plots in the old version, but that was with the static version of the code

[AyushiDaksh]

Hmm, I can't find it either. Must not have been that important. I did spot one other small thing when looking for it thoguh, sorry.

No worries! I have fixed the thing you pointed.

Ah, I must have been confused because there were plots in the old version, but that was with the static version of the code

Yeah we had a static plot during the initial stages of my project, which eventually became dynamic :)

Let me know if this is good to merge @MarkMageeAstro

[AyushiDaksh]

Rebased with master and tested the widget locally again, all seems good.

Please look at https://github.com/tardis-sn/tardis/pull/2328#issuecomment-1989679345 and let me know if anything else is pending here.

Thanks!

[MarkMageeAstro]

Looks good to me and also works on my local install. Thanks @AyushiDaksh!

[AyushiDaksh]

Thanks @MarkMageeAstro !

@jamesgillanders Can you please review/approve so we can merge this?

It was great working on this project with TARDIS. Feel free to tag me in future issues/enhacements related to the Grotrian Diagram.

[andrewfullard]

Just one conflict to resolve! Probably due to file renames recently.