nova-trame 0.20.0__py3-none-any.whl → 0.20.2__py3-none-any.whl

nova/trame/model/data_selector.py

@@ -54,23 +54,17 @@ INSTRUMENTS = {
 }
 
 
-def get_facilities() -> List[str]:
-    return list(INSTRUMENTS.keys())
-
-
-def get_instruments(facility: str) -> List[str]:
-    return list(INSTRUMENTS.get(facility, {}).keys())
-
-
 class DataSelectorState(BaseModel, validate_assignment=True):
     """Selection state for identifying datafiles."""
 
     facility: str = Field(default="", title="Facility")
     instrument: str = Field(default="", title="Instrument")
     experiment: str = Field(default="", title="Experiment")
+    user_directory: str = Field(default="", title="User Directory")
     directory: str = Field(default="")
     extensions: List[str] = Field(default=[])
     prefix: str = Field(default="")
+    show_user_directories: bool = Field(default=False)
 
     @field_validator("experiment", mode="after")
     @classmethod
@@ -81,11 +75,11 @@ class DataSelectorState(BaseModel, validate_assignment=True):
 
     @model_validator(mode="after")
     def validate_state(self) -> Self:
-        valid_facilities = get_facilities()
+        valid_facilities = self.get_facilities()
         if self.facility and self.facility not in valid_facilities:
             warn(f"Facility '{self.facility}' could not be found. Valid options: {valid_facilities}", stacklevel=1)
 
-        valid_instruments = get_instruments(self.facility)
+        valid_instruments = self.get_instruments()
         if self.instrument and self.instrument not in valid_instruments:
             warn(
                 (
@@ -98,25 +92,37 @@ class DataSelectorState(BaseModel, validate_assignment=True):
 
         return self
 
+    def get_facilities(self) -> List[str]:
+        facilities = list(INSTRUMENTS.keys())
+        if self.show_user_directories:
+            facilities.append("User Directory")
+        return facilities
+
+    def get_instruments(self) -> List[str]:
+        return list(INSTRUMENTS.get(self.facility, {}).keys())
+
 
 class DataSelectorModel:
     """Manages file system interactions for the DataSelector widget."""
 
-    def __init__(self, facility: str, instrument: str, extensions: List[str], prefix: str) -> None:
+    def __init__(
+        self, facility: str, instrument: str, extensions: List[str], prefix: str, show_user_directories: bool
+    ) -> None:
         self.state = DataSelectorState()
         self.state.facility = facility
         self.state.instrument = instrument
         self.state.extensions = extensions
         self.state.prefix = prefix
+        self.state.show_user_directories = show_user_directories
 
     def get_facilities(self) -> List[str]:
-        return sorted(get_facilities())
+        return sorted(self.state.get_facilities())
 
     def get_instrument_dir(self) -> str:
         return INSTRUMENTS.get(self.state.facility, {}).get(self.state.instrument, "")
 
     def get_instruments(self) -> List[str]:
-        return sorted(get_instruments(self.state.facility))
+        return sorted(self.state.get_instruments())
 
     def get_experiments(self) -> List[str]:
         experiments = []
@@ -142,17 +148,32 @@ class DataSelectorModel:
 
         return sorted_dirs
 
-    def get_directories(self) -> List[Any]:
+    def get_experiment_directory_path(self) -> Optional[Path]:
         if not self.state.experiment:
+            return None
+
+        return Path("/") / self.state.facility / self.get_instrument_dir() / self.state.experiment
+
+    def get_user_directory_path(self) -> Optional[Path]:
+        if not self.state.user_directory:
+            return None
+
+        return Path("/SNS/users") / self.state.user_directory
+
+    def get_directories(self) -> List[str]:
+        if self.state.facility == "User Directory":
+            base_path = self.get_user_directory_path()
+        else:
+            base_path = self.get_experiment_directory_path()
+
+        if not base_path:
             return []
 
         directories = []
-
-        experiment_path = Path("/") / self.state.facility / self.get_instrument_dir() / self.state.experiment
         try:
-            for dirpath, _, _ in os.walk(experiment_path):
+            for dirpath, _, _ in os.walk(base_path):
                 # Get the relative path from the start path
-                path_parts = os.path.relpath(dirpath, experiment_path).split(os.sep)
+                path_parts = os.path.relpath(dirpath, base_path).split(os.sep)
 
                 # Only create a new entry for top-level directories
                 if len(path_parts) == 1 and path_parts[0] != ".":  # This indicates a top-level directory

nova/trame/view/components/__init__.py

@@ -1,6 +1,17 @@
 from .data_selector import DataSelector
+from .execution_buttons import ExecutionButtons
 from .file_upload import FileUpload
 from .input_field import InputField
+from .progress_bar import ProgressBar
 from .remote_file_input import RemoteFileInput
+from .tool_outputs import ToolOutputWindows
 
-__all__ = ["DataSelector", "FileUpload", "InputField", "RemoteFileInput"]
+__all__ = [
+    "DataSelector",
+    "ExecutionButtons",
+    "FileUpload",
+    "InputField",
+    "ProgressBar",
+    "RemoteFileInput",
+    "ToolOutputWindows",
+]

nova/trame/view/components/data_selector.py

@@ -1,6 +1,7 @@
 """View Implementation for DataSelector."""
 
 from typing import Any, List, Optional, cast
+from warnings import warn
 
 from trame.app import get_server
 from trame.widgets import client, html
@@ -27,6 +28,7 @@ class DataSelector(vuetify.VDataTableVirtual):
         extensions: Optional[List[str]] = None,
         prefix: str = "",
         select_strategy: str = "all",
+        show_user_directories: bool = False,
         **kwargs: Any,
     ) -> None:
         """Constructor for DataSelector.
@@ -48,6 +50,9 @@ class DataSelector(vuetify.VDataTableVirtual):
         select_strategy : str, optional
             The selection strategy to pass to the `VDataTable component <https://trame.readthedocs.io/en/latest/trame.widgets.vuetify3.html#trame.widgets.vuetify3.VDataTable>`__.
             If unset, the `all` strategy will be used.
+        show_user_directories : bool, optional
+            Whether or not to allow users to select data files from user directories. Ignored if the facility parameter
+            is set.
         **kwargs
             All other arguments will be passed to the underlying
             `VDataTable component <https://trame.readthedocs.io/en/latest/trame.widgets.vuetify3.html#trame.widgets.vuetify3.VDataTable>`_.
@@ -64,10 +69,15 @@ class DataSelector(vuetify.VDataTableVirtual):
         else:
             self._label = None
 
+        if facility and show_user_directories:
+            warn("show_user_directories will be ignored since the facility parameter is set.", stacklevel=1)
+
         self._v_model = v_model
+        self._v_model_name_in_state = v_model.split(".")[0]
         self._extensions = extensions if extensions is not None else []
         self._prefix = prefix
         self._select_strategy = select_strategy
+        self._show_user_directories = show_user_directories
 
         self._state_name = f"nova__dataselector_{self._next_id}_state"
         self._facilities_name = f"nova__dataselector_{self._next_id}_facilities"
@@ -76,7 +86,7 @@ class DataSelector(vuetify.VDataTableVirtual):
         self._directories_name = f"nova__dataselector_{self._next_id}_directories"
         self._datafiles_name = f"nova__dataselector_{self._next_id}_datafiles"
 
-        self._flush_state = f"flushState('{self._v_model.split('.')[0]}');"
+        self._flush_state = f"flushState('{self._v_model_name_in_state}');"
         self._reset_state = client.JSEval(exec=f"{self._v_model} = []; {self._flush_state}").exec
 
         self.create_model(facility, instrument)
@@ -96,14 +106,19 @@ class DataSelector(vuetify.VDataTableVirtual):
                 if instrument == "":
                     columns -= 1
                     InputField(
-                        v_model=f"{self._state_name}.instrument", items=(self._instruments_name,), type="autocomplete"
+                        v_if=f"{self._state_name}.facility !== 'User Directory'",
+                        v_model=f"{self._state_name}.instrument",
+                        items=(self._instruments_name,),
+                        type="autocomplete",
                     )
                 InputField(
+                    v_if=f"{self._state_name}.facility !== 'User Directory'",
                     v_model=f"{self._state_name}.experiment",
                     column_span=columns,
                     items=(self._experiments_name,),
                     type="autocomplete",
                 )
+                InputField(v_else=True, v_model=f"{self._state_name}.user_directory", column_span=2)
 
             with GridLayout(columns=2, classes="flex-1-0 h-0", valign="start"):
                 if not self._prefix:
@@ -155,7 +170,9 @@ class DataSelector(vuetify.VDataTableVirtual):
                     )
 
     def create_model(self, facility: str, instrument: str) -> None:
-        self._model = DataSelectorModel(facility, instrument, self._extensions, self._prefix)
+        self._model = DataSelectorModel(
+            facility, instrument, self._extensions, self._prefix, self._show_user_directories
+        )
 
     def create_viewmodel(self) -> None:
         server = get_server(None, client_type="vue3")

nova/trame/view/components/execution_buttons.py

@@ -10,7 +10,10 @@ from nova.trame.view_model.execution_buttons import ExecutionButtonsViewModel
 
 
 class ExecutionButtons:
-    """Execution buttons class. Adds Run/Stop/Cancel/Download buttons to the view."""
+    """Execution buttons class. Adds Run/Stop/Cancel/Download buttons to the view.
+
+    This is intended to be used with the `nova-galaxy ToolRunner <https://nova-application-development.readthedocs.io/projects/nova-galaxy/en/latest/core_concepts/tool_runner.html>`__.
+    """
 
     def __init__(self, id: str, stop_btn: bool = False, download_btn: bool = False) -> None:
         """Constructor for ExecutionButtons.
@@ -18,7 +21,7 @@ class ExecutionButtons:
         Parameters
         ----------
         id : str
-            Component id. Should be used consistently with ToolRunner and other components
+            Component id. Should be used consistently with ToolRunner and other components.
         stop_btn: bool
             Display stop button.
         download_btn : bool

nova/trame/view/components/progress_bar.py

@@ -9,7 +9,10 @@ from nova.trame.view_model.progress_bar import ProgressBarViewModel
 
 
 class ProgressBar:
-    """Progress bar class. Adds progress bar that displays job status to the view."""
+    """Progress bar class. Adds progress bar that displays job status to the view.
+
+    This is intended to be used with the `nova-galaxy ToolRunner <https://nova-application-development.readthedocs.io/projects/nova-galaxy/en/latest/core_concepts/tool_runner.html>`__.
+    """
 
     def __init__(self, id: str) -> None:
         """Constructor for ProgressBar.

nova/trame/view/components/tool_outputs.py

@@ -10,7 +10,10 @@ from nova.trame.view_model.tool_outputs import ToolOutputsViewModel
 
 
 class ToolOutputWindows:
-    """Tool outputs class. Displays windows with tool stdout/stderr."""
+    """Tool outputs class. Displays windows with tool stdout/stderr.
+
+    This is intended to be used with the `nova-galaxy ToolRunner <https://nova-application-development.readthedocs.io/projects/nova-galaxy/en/latest/core_concepts/tool_runner.html>`__.
+    """
 
     def __init__(self, id: str) -> None:
         """Constructor for ToolOutputWindows.

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

@@ -3,7 +3,7 @@
 import json
 import os
 import socketserver
-from asyncio import FIRST_COMPLETED, new_event_loop, set_event_loop, wait
+from asyncio import FIRST_COMPLETED, create_task, new_event_loop, set_event_loop, wait
 from io import BytesIO
 from mimetypes import types_map
 from pathlib import Path
@@ -188,9 +188,9 @@ class MatplotlibFigure(matplotlib.Figure):
                         raise ValueError("unexpected message type: %s", print(msg))
 
             # Forward websocket data in both directions
-            await wait(
-                [ws_forward(ws_server, ws_client), ws_forward(ws_client, ws_server)], return_when=FIRST_COMPLETED
-            )
+            server_to_client = create_task(ws_forward(ws_server, ws_client))
+            client_to_server = create_task(ws_forward(ws_client, ws_server))
+            await wait([server_to_client, client_to_server], return_when=FIRST_COMPLETED)
             await client_session.close()  # Ensure the connection is cleaned up when the Trame client disconnects.
 
             return ws_server

nova/trame/view_model/data_selector.py

@@ -29,17 +29,23 @@ class DataSelectorViewModel:
         self.model.set_state(facility, instrument, experiment)
         self.update_view()
 
+    def reset(self) -> None:
+        self.model.set_directory("")
+        self.reset_bind.update_in_view(None)
+
     def on_state_updated(self, results: Dict[str, Any]) -> None:
         for update in results.get("updated", []):
             match update:
                 case "facility":
                     self.model.set_state(facility=None, instrument="", experiment="")
-                    self.model.set_directory("")
-                    self.reset_bind.update_in_view(None)
+                    self.reset()
                 case "instrument":
                     self.model.set_state(facility=None, instrument=None, experiment="")
-                    self.model.set_directory("")
-                    self.reset_bind.update_in_view(None)
+                    self.reset()
+                case "experiment":
+                    self.reset()
+                case "user_directory":
+                    self.reset()
         self.update_view()
 
     def update_view(self) -> None:

{nova_trame-0.20.0.dist-info → nova_trame-0.20.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: nova-trame
-Version: 0.20.0
+Version: 0.20.2
 Summary: A Python Package for injecting curated themes and custom components into Trame applications
 License: MIT
 Keywords: NDIP,Python,Trame,Vuetify

{nova_trame-0.20.0.dist-info → nova_trame-0.20.2.dist-info}/RECORD

@@ -1,18 +1,18 @@
 nova/__init__.py,sha256=ED6jHcYiuYpr_0vjGz0zx2lrrmJT9sDJCzIljoDfmlM,65
 nova/trame/__init__.py,sha256=gFrAg1qva5PIqR5TjvPzAxLx103IKipJLqp3XXvrQL8,59
-nova/trame/model/data_selector.py,sha256=sCLU0YIMCccC1BH8dKZPmajaft6WgwuM_zOr3NPk2bg,7552
+nova/trame/model/data_selector.py,sha256=bKWMk9bVhC16DTuEI7o656idMxzLbUi7RBdiaGO6TZY,8377
 nova/trame/model/remote_file_input.py,sha256=9KAf31ZHzpsh_aXUrNcF81Q5jvUZDWCzW1QATKls-Jk,3675
-nova/trame/view/components/__init__.py,sha256=u8yzshFp_TmuC1g9TRxKjy_BdGWMIzPQouI52hzcr2U,234
-nova/trame/view/components/data_selector.py,sha256=UFQriSH25wk3F4s6EnP5Dfrt3MFbisJTrzmRxH0ME8U,8831
-nova/trame/view/components/execution_buttons.py,sha256=wXpgF6osuAivKKnby8yCevoFa4PbRlCtUgEymjiugzE,3857
+nova/trame/view/components/__init__.py,sha256=60BeS69aOrFnkptjuD17rfPE1f4Z35iBH56TRmW5MW8,451
+nova/trame/view/components/data_selector.py,sha256=IQipVqf6fG7qVRa4CJSr4jGz7Sru_lYU6K-qczJdstg,9727
+nova/trame/view/components/execution_buttons.py,sha256=fIkrWKI3jFZqk3GHhtmYh3nK2c-HOXpD3D3zd_TUpi0,4049
 nova/trame/view/components/file_upload.py,sha256=7VcpfA6zmiqMDLkwVPlb35Tf0IUTBN1xsHpoUFnSr1w,3111
 nova/trame/view/components/input_field.py,sha256=q6WQ_N-BOlimUL9zgazDlsDfK28FrrKjH4he8e_HzRA,16088
-nova/trame/view/components/progress_bar.py,sha256=vva_blYZwF1xJt72sCBSbJB5HloyTy39UoVOP_ixs_E,1995
+nova/trame/view/components/progress_bar.py,sha256=Sh5cOPaMWrFq8KTWEDui1dIbK53BPtGG2RZOSKEaoJ4,2186
 nova/trame/view/components/remote_file_input.py,sha256=ByrBFj8svyWezcardCWrS_4Ag3fgTYNg_11lDW1FIA8,9669
-nova/trame/view/components/tool_outputs.py,sha256=IlpvJJuVZ6o9WMXW1Hpsvca7Xw1AxO83fdr_JFcYnbA,2146
+nova/trame/view/components/tool_outputs.py,sha256=-6pDURd2l_FK_8EWa9BI3KhU_KJXJ6uyJ_rW4nQVc08,2337
 nova/trame/view/components/visualization/__init__.py,sha256=reqkkbhD5uSksHHlhVMy1qNUCwSekS5HlXk6wCREYxU,152
 nova/trame/view/components/visualization/interactive_2d_plot.py,sha256=foZCMoqbuahT5dtqIQvm8C4ZJcY9P211eJEcpQJltmM,3421
-nova/trame/view/components/visualization/matplotlib_figure.py,sha256=0iWCXB8i7Tut1gA66hY9cGrhZPaHC7p-XdADDNy_UVY,12042
+nova/trame/view/components/visualization/matplotlib_figure.py,sha256=GGH2cx-dQFkMAOTnlCrzMGDb2TN451I9J3gAS8tx2cs,12147
 nova/trame/view/layouts/__init__.py,sha256=cMrlB5YMUoK8EGB83b34UU0kPTVrH8AxsYvKRtpUNEc,141
 nova/trame/view/layouts/grid.py,sha256=BYoylq-VN1l55BXBWMJ_7zvHcQYmfOo811nzD72IBOQ,5522
 nova/trame/view/layouts/hbox.py,sha256=qlOMp_iOropIkC9Jxa6D89b7OPv0pNvJ73tUEzddyhQ,3513
@@ -27,13 +27,13 @@ nova/trame/view/theme/assets/js/lodash.throttle.min.js,sha256=9csqjX-M-LVGJnF3z4
 nova/trame/view/theme/assets/vuetify_config.json,sha256=a0FSgpLYWGFlRGSMhMq61MyDFBEBwvz55G4qjkM08cs,5627
 nova/trame/view/theme/theme.py,sha256=HUeuVfzEgeYW65W-LcvXzfYNRHu6aQibGwwgHGyh3OA,11765
 nova/trame/view/utilities/local_storage.py,sha256=vD8f2VZIpxhIKjZwEaD7siiPCTZO4cw9AfhwdawwYLY,3218
-nova/trame/view_model/data_selector.py,sha256=FM1Xe-f-gi1jVwA9nDf2KE1UDvsAvmMKlp78slIpX58,2418
+nova/trame/view_model/data_selector.py,sha256=WrdvCE8J_sye19srGBpBZbheu_YzBEEEo_u098WLh9g,2524
 nova/trame/view_model/execution_buttons.py,sha256=MfKSp95D92EqpD48C15cBo6dLO0Yld4FeRZMJNxJf7Y,3551
 nova/trame/view_model/progress_bar.py,sha256=L7ED6TDn5v2142iu-qt3i-jUg_5JEhLyC476t2OtohU,2467
 nova/trame/view_model/remote_file_input.py,sha256=ojEOJ8ZPkajpbAaZi9VLj7g-uBjhb8BMrTdMmwf_J6A,3367
 nova/trame/view_model/tool_outputs.py,sha256=ev6LY7fJ0H2xAJn9f5ww28c8Kpom2SYc2FbvFcoN4zg,829
-nova_trame-0.20.0.dist-info/LICENSE,sha256=Iu5QiDbwNbREg75iYaxIJ_V-zppuv4QFuBhAW-qiAlM,1061
-nova_trame-0.20.0.dist-info/METADATA,sha256=0URjV5ll_dfW8d0kB_EnpCa0ttbNEObIsk0J8HevEu0,1523
-nova_trame-0.20.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-nova_trame-0.20.0.dist-info/entry_points.txt,sha256=J2AmeSwiTYZ4ZqHHp9HO6v4MaYQTTBPbNh6WtoqOT58,42
-nova_trame-0.20.0.dist-info/RECORD,,
+nova_trame-0.20.2.dist-info/LICENSE,sha256=Iu5QiDbwNbREg75iYaxIJ_V-zppuv4QFuBhAW-qiAlM,1061
+nova_trame-0.20.2.dist-info/METADATA,sha256=i1PstjeVf8uot5fcZJEFQEjonqmUPlrRASpnl7safhY,1523
+nova_trame-0.20.2.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+nova_trame-0.20.2.dist-info/entry_points.txt,sha256=J2AmeSwiTYZ4ZqHHp9HO6v4MaYQTTBPbNh6WtoqOT58,42
+nova_trame-0.20.2.dist-info/RECORD,,