[GSoC] Rewrite the TARDIS visualisation module using Panel #2989
Conversation
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
|
*beep* *bop* 6 F401 [*] `numpy` imported but unused
3 I001 [*] Import block is un-sorted or un-formatted
1 PIE808 [*] Unnecessary `start` argument in `range`
Complete output(might be large): docs/analysing_tardis_outputs/visualization/how_to_generating_widgets.ipynb:cell 3:2:33: F401 [*] `tardis.io.atom_data.download_atom_data` imported but unused
docs/analysing_tardis_outputs/visualization/how_to_generating_widgets.ipynb:cell 5:1:1: I001 [*] Import block is un-sorted or un-formatted
docs/analysing_tardis_outputs/visualization/how_to_generating_widgets.ipynb:cell 5:3:5: F401 [*] `tardis.visualization.shell_info_from_hdf` imported but unused
tardis/visualization/widgets/shell_info.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/visualization/widgets/shell_info.py:1:25: F401 [*] `tardis.base.run_tardis` imported but unused
tardis/visualization/widgets/shell_info.py:2:51: F401 [*] `tardis.io.atom_data.atom_web_download.download_atom_data` imported but unused
tardis/visualization/widgets/shell_info.py:6:5: F401 [*] `tardis.util.base.is_notebook` imported but unused
tardis/visualization/widgets/shell_info.py:12:17: F401 [*] `numpy` imported but unused
tardis/visualization/widgets/shell_info.py:300:25: PIE808 [*] Unnecessary `start` argument in `range`
tardis/visualization/widgets/util.py:3:1: I001 [*] Import block is un-sorted or un-formatted
Found 10 errors.
[*] 10 fixable with the `--fix` option.
|
|
*beep* *bop* Hi, human. The Click here to see the build log. |
| """Event listener to update the data in element count table widget based | ||
| on interaction (row selected event) in shells table widget. | ||
|
|
||
| Parameters | ||
| ---------- | ||
| event : dict | ||
| Dictionary that holds information about event (see Notes section) | ||
| qgrid_widget : qgrid.QgridWidget | ||
| QgridWidget instance that fired the event (see Notes section) | ||
|
|
||
| Notes | ||
| ----- | ||
| You will never need to pass any of these arguments explicitly. This is | ||
| the expected signature of the function passed to :code:`handler` argument |
There was a problem hiding this comment.
Why remove this?
Since I have migrated the shell info widget to using panel completely, there is no usage of qgrid and its widgets, hence removed the docstrings which were related to qgrid.
| Label like widget to show summary of a qgrid table widget. | ||
|
|
||
| Also handles aligning the label with the table columns exactly like a | ||
| summary row. | ||
| """ |
There was a problem hiding this comment.
same here
Same for this one, the docstring talked about the qgrid table widgets, which I have removed and migrated to using panel widgets functionality.
|
|
||
| Notes | ||
| ----- | ||
| This decorator is reproduced from ipywidgets documentation, for more information | ||
| please see https://ipywidgets.readthedocs.io/en/latest/examples/Widget%20Events.html#debounce |
There was a problem hiding this comment.
here too
Same, since the project idea talks about removing every usage of IPython too (along with qgrid & qgridnext), hence I removed the Notes, should I revert the docstring changes for the whole class Timer?
📝 Description
Type: 🪲
bugfix| 🚀feature| ☣️breaking change| 🚦testing| 📝documentation| 🎢infrastructure🟢 This PR completes the first objective of Rewrite the TARDIS visualisation module using Panel, by migrating the shell info widget to completely using
paneland more importantly by removing any dependancy onqgrid,qgridnextandIPython.🟢 The Bonus mentioned in the PR is also completed, i.e. used the SimulationShellInfo and displayed the hierarchical dataset as interlinked tables where selecting a row in the first table updates the 2nd table with the data corresponding to the selected row. Additionally, the 1st table displaying
shell dataand the 2nd table displayingelement abundances, further selecting a row further updates the 3rd and 4th table dislayingionandlevelcount data respectively.🟢 The Widget runs at both places, in-place jupyter notebook and also on a separate localhost server.
Screen Recordings of the Widget Interaction:
Notebook.mp4
localhostserver.mp4
📌 Resources
Examples, notebooks, and links to useful references.
🚦 Testing
How did you test these changes?
☑️ Checklist
build_docslabelcc: @andrewfullard @atharva-2001 @KasukabeDefenceForce @jamesgillanders @wkerzendorf