nova-trame 1.0.0rc5__py3-none-any.whl → 1.0.1__py3-none-any.whl

nova/trame/view/components/ornl/neutron_data_selector.py

@@ -91,7 +91,7 @@ class NeutronDataSelector(DataSelector):
         if data_source == "oncat" and subdirectory:
             warn("subdirectory will be ignored since data will be pulled from ONCat.", stacklevel=1)
 
-        if isinstance(facility, str) and allow_custom_directories:
+        if isinstance(facility, str) and facility and allow_custom_directories:
             warn("allow_custom_directories will be ignored since the facility parameter is fixed.", stacklevel=1)
 
         self._facility = facility
@@ -319,3 +319,9 @@ class NeutronDataSelector(DataSelector):
             experiment=set_state_param(self.state, (self._selected_experiment_name,), experiment),
         )
         self._vm.reset()
+
+    def set_state(self, *args: Any, **kwargs: Any) -> None:
+        raise TypeError(
+            "The set_state method has been removed. Please use update_facility, update_instrument, and "
+            "update_experiment instead."
+        )

nova/trame/view/components/visualization/matplotlib_figure.py

@@ -13,7 +13,7 @@ from warnings import warn
 
 import tornado
 from aiohttp import ClientSession, WSMsgType, web
-from matplotlib import get_data_path
+from matplotlib import get_data_path, rcParams
 from matplotlib.backends.backend_webagg import FigureManagerWebAgg, new_figure_manager_given_figure  # type: ignore
 from matplotlib.figure import Figure
 from trame.app import get_server
@@ -56,7 +56,10 @@ class _MPLApplication(tornado.web.Application):
                 self.supports_binary = message["value"]
             else:
                 manager = self.application.manager  # type: ignore
-                manager.handle_json(message)
+                try:
+                    manager.handle_json(message)
+                except Exception:
+                    manager.refresh_all()
 
         def send_json(self, content: Any) -> None:
             set_event_loop(self.application.loop)  # type: ignore
@@ -229,7 +232,6 @@ class MatplotlibFigure(matplotlib.Figure):
         else:
             kwargs["classes"] = "flex-1-1"
         if webagg:
-            self._initial_resize = True
             if "id" in kwargs:
                 kwargs.pop("id")
                 warn("id parameter to MatplotlibFigure is ignored when webagg=True.", stacklevel=1)
@@ -264,7 +266,7 @@ class MatplotlibFigure(matplotlib.Figure):
             f"window.document.querySelectorAll('.nova-mpl').forEach((item) => {{ item.style.display = ''; }});"
             "window.trame.trigger("
             f"  '{self._id}_resize',"
-            f"  [height, width, window.devicePixelRatio]"
+            f"  [height, width]"
             ");"
         )
         self._resize_figure = client.JSEval(exec=self._trigger).exec
@@ -280,29 +282,21 @@ class MatplotlibFigure(matplotlib.Figure):
         ).exec
 
         @self._server.controller.trigger(f"{self._id}_resize")
-        def resize_figure(height: int, width: int, device_pixel_ratio: float) -> None:
+        def resize_figure(height: int, width: int) -> None:
             if self._figure:
-                # This is the browser standard assumption for DPI.
-                dpi = 96
-
                 if self._webagg:
                     # Reserve space for the controls injected by webagg.
                     height -= 48
                     width -= 4
 
-                    if not self._initial_resize:
-                        # Handle device pixel ratio for retina displays
-                        dpi = int(dpi * device_pixel_ratio)
-                        height = int(height * device_pixel_ratio)
-                        width = int(width * device_pixel_ratio)
-
                 if height <= 0 or width <= 0:
                     return
 
                 if self._webagg:
-                    self._initial_resize = False
-
-                self._figure.set_dpi(dpi)
+                    # Webagg does not respect the Figure object's DPI.
+                    dpi = rcParams["figure.dpi"]
+                else:
+                    dpi = self._figure.get_dpi()
                 new_width = width / dpi
                 new_height = height / dpi
                 current_size = self._figure.get_size_inches()

nova/trame/view/theme/assets/core_style.scss

@@ -12,6 +12,13 @@ html {
     box-shadow: none !important;
 }
 
+.exit-button {
+    .v-btn__content,
+    .v-btn__prepend i {
+        font-size: 0.875rem !important;
+    }
+}
+
 .mpl-message, .ui-dialog-titlebar {
     display: none !important;
 }
@@ -20,6 +27,10 @@ html {
     white-space: pre-wrap;
 }
 
+.nova-pre-content:empty {
+    margin-bottom: 12px !important;
+}
+
 .nova-data-selector {
     .v-list-group {
         --prepend-width: 12px !important;
@@ -86,6 +97,8 @@ html {
 
 @media only screen and (max-width: 959px) {
     .d-grid {
+        /* This forces all grid rows to have the same height. If one doesn't want this to happen, then they should use the box layouts. :) */
+        grid-auto-rows: 1fr;
         grid-template-columns: repeat(1, 1fr) !important;
     }
 
@@ -183,7 +196,7 @@ html {
         font-size: 1rem;
     }
 
-    .v-btn {
+    .v-btn:not(.exit-button) {
         min-width: 0px !important;
         padding: 5px 5px !important;
         box-shadow: none !important;

nova/trame/view/theme/assets/js/revo_grid.js

@@ -4,11 +4,15 @@ class RevoGrid {
         this.modelKey = modelKey
         this.dataKey = dataKey
         this.stateKey = stateKey
+        this.lastSelection = null
+        this.shiftPressed = false
 
         this.grid = document.querySelector(`#${this.id}`)
         this.grid.addEventListener('viewportscroll', () => {
             this.updateCheckboxes()
         })
+
+        this.initShiftKeyListeners()
     }
 
     updateCheckboxes() {
@@ -66,11 +70,32 @@ class RevoGrid {
                 const path = props.data[props.rowIndex].path
                 const index = modelValue.indexOf(path)
 
-                // We need to assign instead of modifying in place in order for the Trame watcher to pick up changes.
+                // I use _.set instead of modifying the modelValue in place in order for the Trame watcher to properly detect the change.
                 if (e.target.checked && index < 0) {
-                    _.set(trameState, this.modelKey, _.concat(modelValue, path))
+                    const newIndex = props.data.findIndex((entry) => entry.path === path)
+
+                    if (this.shiftPressed && this.lastSelection !== null) {
+                        let newPaths = []
+                        // JavaScript doesn't allow a backwards step during slice, so we need to order the start/stop correctly.
+                        if (this.lastSelection < newIndex) {
+                            newPaths = props.data.slice(this.lastSelection, newIndex + 1)
+                        } else {
+                            newPaths = props.data.slice(newIndex, this.lastSelection)
+                        }
+                        // Exclude paths that are already selected to avoid duplicates.
+                        newPaths = newPaths.map((entry) => entry.path).filter((path) => !modelValue.includes(path))
+
+                        _.set(trameState, this.modelKey, _.concat(modelValue, newPaths))
+                    } else {
+                        _.set(trameState, this.modelKey, _.concat(modelValue, path))
+                    }
+
+                    this.lastSelection = newIndex
                 } else if (index >= 0) {
                     _.set(trameState, this.modelKey, modelValue.toSpliced(index, 1))
+
+                    // Only allow range selection if the last action was to select a file.
+                    this.lastSelection = null
                 }
 
                 // Update the UI
@@ -103,6 +128,18 @@ class RevoGrid {
 
         return [inputVNode, 'Available Datafiles']
     }
+
+    initShiftKeyListeners() {
+        window.document.addEventListener('keydown', (e) => {
+            this.shiftPressed = e.shiftKey
+        })
+
+        window.document.addEventListener('keyup', (e) => {
+            if (e.key === 'Shift') {
+                this.shiftPressed = false
+            }
+        })
+    }
 }
 
 class RevoGridManager {

nova/trame/view/theme/exit_button.py

@@ -1,9 +1,11 @@
 """Components used to control the lifecycle of a Themed Application."""
 
 import logging
+from asyncio import sleep
 from typing import Any
 
 from trame.app import get_server
+from trame.widgets import client
 from trame.widgets import vuetify3 as vuetify
 
 logger = logging.getLogger(__name__)
@@ -20,6 +22,10 @@ class ExitButton:
         self.server.state.nova_show_stop_jobs_on_exit_checkbox = False
         self.server.state.nova_running_jobs = []
         self.server.state.nova_show_exit_progress = False
+        # Note that window.close() will fail in many situations due to security concerns: https://developer.mozilla.org/en-US/docs/Web/API/Window/close
+        # This is simply a best effort to close the tab. My hope is that it will generally work when people are running
+        # applications through our dashboard since tabs are opened via target="_blank" links.
+        self.close_browser = client.JSEval(exec="window.close();").exec
         self.exit_application_callback = exit_callback
         self.job_status_callback = job_status_callback
         self.create_ui()
@@ -28,9 +34,10 @@ class ExitButton:
         with vuetify.VBtn(
             "Exit",
             prepend_icon="mdi-close-box",
-            classes="mr-4 bg-error",
+            classes="exit-button mr-4 bg-secondary",
             id="shutdown_app_theme_button",
             color="white",
+            size="default",
             click=self.open_exit_dialog,
         ):
             with vuetify.VDialog(v_model="nova_show_exit_dialog", persistent="true"):
@@ -51,7 +58,7 @@ class ExitButton:
                     with vuetify.VCardActions(v_if="!nova_show_exit_progress"):
                         vuetify.VBtn(
                             "Exit App",
-                            click=self.exit_application_callback,
+                            click=self.exit_application,
                             color="error",
                         )
                         vuetify.VBtn(
@@ -65,6 +72,13 @@ class ExitButton:
                         )
                         vuetify.VProgressCircular(indeterminate=True)
 
+    async def exit_application(self) -> None:
+        self.close_browser()
+
+        # sleep gives time for the Trame server to communicate the close request to the browser.
+        await sleep(0.1)
+        await self.exit_application_callback()
+
     async def open_exit_dialog(self) -> None:
         self.server.state.nova_show_exit_dialog = True
         await self.job_status_callback()

nova/trame/view/theme/theme.py

@@ -3,6 +3,7 @@
 import asyncio
 import json
 import logging
+import os
 import sys
 from asyncio import create_task
 from functools import partial
@@ -210,6 +211,10 @@ class ThemedApp:
         -------
         `trame_client.ui.core.AbstractLayout <https://trame.readthedocs.io/en/latest/core.ui.html#trame_client.ui.core.AbstractLayout>`_
         """
+        # This detects if Poetry is running Python so that we can show links to NOVA resources during development.
+        # Poetry should not be used in production.
+        show_nova_resources = os.environ.get("VIRTUAL_ENV") is not None
+
         with VAppLayout(self.server, vuetify_config=self.vuetify_config) as layout:
             self.local_storage = LocalStorageManager(self.server.controller)
 
@@ -225,8 +230,32 @@ class ThemedApp:
                     with vuetify.VAppBar() as toolbar:
                         layout.toolbar = toolbar
 
-                        with vuetify.VAppBarTitle() as toolbar_title:
+                        with vuetify.VAppBarTitle(classes="flex-0-1") as toolbar_title:
                             layout.toolbar_title = toolbar_title
+
+                        if show_nova_resources:
+                            vuetify.VBtn(
+                                "NOVA Examples",
+                                classes="ml-4",
+                                href="https://github.com/nova-model/nova-examples/",
+                                __properties=["target"],
+                                target="_blank",
+                            )
+                            html.Div("·", classes="mx-1")
+                            vuetify.VBtn(
+                                "NOVA Tutorial",
+                                href="https://nova.ornl.gov/tutorial/",
+                                __properties=["target"],
+                                target="_blank",
+                            )
+                            html.Div("·", classes="mx-1")
+                            vuetify.VBtn(
+                                "NOVA Documentation",
+                                href="https://nova-application-development.readthedocs.io/en/latest/",
+                                __properties=["target"],
+                                target="_blank",
+                            )
+
                         vuetify.VSpacer()
                         with html.Div(classes="mr-2") as actions:
                             layout.actions = actions
@@ -259,7 +288,7 @@ class ThemedApp:
 
                     with vuetify.VMain(classes="align-stretch d-flex flex-column h-screen"):
                         # [slot override example]
-                        layout.pre_content = vuetify.VSheet(classes="bg-background flex-0-1 mt-1 ")
+                        layout.pre_content = vuetify.VSheet(classes="bg-background flex-0-1 mt-1 nova-pre-content ")
                         # [slot override example complete]
                         with vuetify.VContainer(classes="flex-1-1 overflow-hidden pt-0 pb-2", fluid=True):
                             layout.content = vuetify.VCard(

{nova_trame-1.0.0rc5.dist-info → nova_trame-1.0.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nova-trame
-Version: 1.0.0rc5
+Version: 1.0.1
 Summary: A Python Package for injecting curated themes and custom components into Trame applications
 License-Expression: MIT
 License-File: LICENSE
@@ -38,7 +38,7 @@ Description-Content-Type: text/markdown
 nova-trame
 ==========
 
-`nova-trame` is a Python package for streamlining development of Trame applications used in the NOVA project.
+`nova-trame` is a Python package for streamlining development of Trame applications used in the NOVA framework.
 
 You can install this package directly with
 
@@ -46,6 +46,13 @@ You can install this package directly with
 pip install nova-trame
 ```
 
+Once installed, you can check that it's working by running the widget gallery we use for visually testing components available through NOVA and Trame. We use [Poetry](https://python-poetry.org/) internally and recommend it for running the gallery.
+
+```commandline
+poetry install
+poetry run app
+```
+
 A user guide, examples, and a full API for this package can be found at [https://nova-application-development.readthedocs.io/en/stable/](https://nova-application-development.readthedocs.io/projects/nova-trame/en/stable/).
 
 Developers: please read [this document](DEVELOPMENT.md)

{nova_trame-1.0.0rc5.dist-info → nova_trame-1.0.1.dist-info}/RECORD

@@ -12,27 +12,27 @@ nova/trame/view/components/execution_buttons.py,sha256=Br6uAmE5bY67TTYc5ZTHECNJ_
 nova/trame/view/components/file_upload.py,sha256=WOaFXeNNwN0DYZJr-W6vWdBiTpr7m-lq3WKJaHmeMe8,4560
 nova/trame/view/components/input_field.py,sha256=xzCmNEoB4ljGx99-gGgTV0UwriwtS8ce22zPA4QneZw,17372
 nova/trame/view/components/ornl/__init__.py,sha256=HnxzzSsxw0vQSDCVFfWsAxx1n3HnU37LMuQkfiewmSU,90
-nova/trame/view/components/ornl/neutron_data_selector.py,sha256=duiPbROIYsU6h0oZP27wSce6BJuW1mdT8mGoxY05lyw,16542
+nova/trame/view/components/ornl/neutron_data_selector.py,sha256=3IxEYM3wK7RskxbjDG94JeWBCEWXBeF3xBDWt3Bh1OU,16797
 nova/trame/view/components/progress_bar.py,sha256=zhbJwPy_HPQ8YL-ISN8sCRUQ7qY6qqo9wiV59BmvL8I,3038
 nova/trame/view/components/remote_file_input.py,sha256=mcz_bmI2rD8gdmIOKLhlzfj-XoWBwC99T9ZgQORaKqE,14674
 nova/trame/view/components/tool_outputs.py,sha256=IbYV4VjrkWAE354Bh5KH76SPsxGLIkOXChijS4-ce_Y,2408
 nova/trame/view/components/visualization/__init__.py,sha256=reqkkbhD5uSksHHlhVMy1qNUCwSekS5HlXk6wCREYxU,152
 nova/trame/view/components/visualization/interactive_2d_plot.py,sha256=z2s1janxAclpMEdDJk3z-CQ6r3KPNoR_SXPx9ppWnuQ,3481
-nova/trame/view/components/visualization/matplotlib_figure.py,sha256=GYfX7hlEWQ4Dghk8Z1dmUQr6jgktWirhOYb0drtonM4,16297
+nova/trame/view/components/visualization/matplotlib_figure.py,sha256=8JgbF6elZC8EFZn-c2mLqGSyg0Lb4NLVAKJVSBb9-5g,16010
 nova/trame/view/layouts/__init__.py,sha256=cMrlB5YMUoK8EGB83b34UU0kPTVrH8AxsYvKRtpUNEc,141
 nova/trame/view/layouts/grid.py,sha256=DU5u5JTE0ulzCaJsEWyTenBH9lOQD7mtoC6RZXxDTPE,6110
 nova/trame/view/layouts/hbox.py,sha256=w6ow7Qzmq4slODz_9f7kEigCVPE2PhUmPODedYH34f4,3850
 nova/trame/view/layouts/utils.py,sha256=Hg34VQWTG3yHBsgNvmfatR4J-uL3cko7UxSJpT-h3JI,376
 nova/trame/view/layouts/vbox.py,sha256=Kkci79zDKF6qNH4HeDPYquJcixXx3BS63NVmS3FlOiw,3851
 nova/trame/view/theme/__init__.py,sha256=70_marDlTigIcPEOGiJb2JTs-8b2sGM5SlY7XBPtBDM,54
-nova/trame/view/theme/assets/core_style.scss,sha256=lZK8zghy4ExmNuFI-rfq7qt2S7bqObzM_MBviOlWP5c,4481
+nova/trame/view/theme/assets/core_style.scss,sha256=4elBD5n0Mrgl_-U7NycisPaIDGLiU8MR-7nSml2i6Q0,4844
 nova/trame/view/theme/assets/favicon.png,sha256=Xbp1nUmhcBDeObjsebEbEAraPDZ_M163M_ZLtm5AbQc,1927
 nova/trame/view/theme/assets/js/delay_manager.js,sha256=BN4OL88QsyZG4XQ1sTorHpN1rwD4GnWoVKHvl5F5ydo,776
 nova/trame/view/theme/assets/js/lodash.min.js,sha256=KCyAYJ-fsqtp_HMwbjhy6IKjlA5lrVrtWt1JdMsC57k,73016
-nova/trame/view/theme/assets/js/revo_grid.js,sha256=fbuEWO8etw-xgo9tjJGjJXdd5wL8qpgabPmrnU6Jp8k,4081
+nova/trame/view/theme/assets/js/revo_grid.js,sha256=73v-GP4IUIg8OgMnRCoHB6ERFU18nx0VYaEecV_7u-o,5695
 nova/trame/view/theme/assets/vuetify_config.json,sha256=a0FSgpLYWGFlRGSMhMq61MyDFBEBwvz55G4qjkM08cs,5627
-nova/trame/view/theme/exit_button.py,sha256=Kqv1GVJZGrSsj6_JFjGU3vm3iNuMolLC2T1x2IsdmV0,3094
-nova/trame/view/theme/theme.py,sha256=Jeoi-qrokSO-dDYpEvicbqfwzalhhbG-4HplD8NFj6s,13269
+nova/trame/view/theme/exit_button.py,sha256=GrgCMLytIrDTWAMtkuFv5JaIBpslFrmI5k2izklSqQs,3872
+nova/trame/view/theme/theme.py,sha256=YecxrUw5I-7NDTyC8jrVdpb49U1TMzIbwO7jDid_jN0,14715
 nova/trame/view/utilities/local_storage.py,sha256=vD8f2VZIpxhIKjZwEaD7siiPCTZO4cw9AfhwdawwYLY,3218
 nova/trame/view_model/data_selector.py,sha256=jAtq5hpohQ6YiLBbgLJfNUzWZBpN2bjCG_c_FCJu2ns,3186
 nova/trame/view_model/execution_buttons.py,sha256=MfKSp95D92EqpD48C15cBo6dLO0Yld4FeRZMJNxJf7Y,3551
@@ -40,8 +40,8 @@ nova/trame/view_model/ornl/neutron_data_selector.py,sha256=PIKQyzcHpwu81DNk3d8Af
 nova/trame/view_model/progress_bar.py,sha256=6AUKHF3hfzbdsHqNEnmHRgDcBKY5TT8ywDx9S6ovnsc,2854
 nova/trame/view_model/remote_file_input.py,sha256=zWOflmCDJYYR_pacHphwzricV667GSRokh-mlxpBAOo,3646
 nova/trame/view_model/tool_outputs.py,sha256=ev6LY7fJ0H2xAJn9f5ww28c8Kpom2SYc2FbvFcoN4zg,829
-nova_trame-1.0.0rc5.dist-info/METADATA,sha256=E07ThBY0ho0JJE66zWp3IQJadp1e-nydsrAnUz93BTo,1798
-nova_trame-1.0.0rc5.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
-nova_trame-1.0.0rc5.dist-info/entry_points.txt,sha256=J2AmeSwiTYZ4ZqHHp9HO6v4MaYQTTBPbNh6WtoqOT58,42
-nova_trame-1.0.0rc5.dist-info/licenses/LICENSE,sha256=Iu5QiDbwNbREg75iYaxIJ_V-zppuv4QFuBhAW-qiAlM,1061
-nova_trame-1.0.0rc5.dist-info/RECORD,,
+nova_trame-1.0.1.dist-info/METADATA,sha256=nuokD6J6QRyTeX4MUlD2JoYA01sJ5uMz6j5OXDBsXig,2096
+nova_trame-1.0.1.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+nova_trame-1.0.1.dist-info/entry_points.txt,sha256=J2AmeSwiTYZ4ZqHHp9HO6v4MaYQTTBPbNh6WtoqOT58,42
+nova_trame-1.0.1.dist-info/licenses/LICENSE,sha256=Iu5QiDbwNbREg75iYaxIJ_V-zppuv4QFuBhAW-qiAlM,1061
+nova_trame-1.0.1.dist-info/RECORD,,