nova-trame 0.25.5__py3-none-any.whl → 0.26.2__py3-none-any.whl

nova/trame/model/ornl/analysis_data_selector.py

@@ -0,0 +1,166 @@
+"""Analysis cluster filesystem backend for NeutronDataSelector."""
+
+import os
+from pathlib import Path
+from typing import Any, Dict, List, Optional
+from warnings import warn
+
+from natsort import natsorted
+from pydantic import Field, model_validator
+from typing_extensions import Self
+
+from .neutron_data_selector import NeutronDataSelectorModel, NeutronDataSelectorState
+
+CUSTOM_DIRECTORIES_LABEL = "Custom Directory"
+
+INSTRUMENTS = {
+    "HFIR": {
+        "CG-1A": "CG1A",
+        "DEV BEAM": "CG1B",
+        "MARS": "CG1D",
+        "GP-SANS": "CG2",
+        "BIO-SANS": "CG3",
+        "CNPDB": "CG4B",
+        "CTAX": "CG4C",
+        "IMAGINE": "CG4D",
+        "PTAX": "HB1",
+        "VERITAS": "HB1A",
+        "POWDER": "HB2A",
+        "HIDRA": "HB2B",
+        "WAND²": "HB2C",
+        "TAX": "HB3",
+        "DEMAND": "HB3A",
+        "NOWG": "NOWG",
+        "NOWV": "NOWV",
+    },
+    "SNS": {
+        "ARCS": "ARCS",
+        "BL-0": "BL0",
+        "BASIS": "BSS",
+        "CNCS": "CNCS",
+        "CORELLI": "CORELLI",
+        "EQ-SANS": "EQSANS",
+        "HYSPEC": "HYS",
+        "MANDI": "MANDI",
+        "NOMAD": "NOM",
+        "NOWB": "NOWB",
+        "NOWD": "NOWD",
+        "NSE": "NSE",
+        "POWGEN": "PG3",
+        "LIQREF": "REF_L",
+        "MAGREF": "REF_M",
+        "SEQUOIA": "SEQ",
+        "SNAP": "SNAP",
+        "TOPAZ": "TOPAZ",
+        "USANS": "USANS",
+        "VENUS": "VENUS",
+        "VISION": "VIS",
+        "VULCAN": "VULCAN",
+    },
+}
+
+
+class AnalysisDataSelectorState(NeutronDataSelectorState):
+    """Selection state for identifying datafiles."""
+
+    allow_custom_directories: bool = Field(default=False)
+    custom_directory: str = Field(default="", title="Custom Directory")
+
+    @model_validator(mode="after")
+    def validate_state(self) -> Self:
+        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 = self.get_instruments()
+        if self.instrument and self.facility != CUSTOM_DIRECTORIES_LABEL and self.instrument not in valid_instruments:
+            warn(
+                (
+                    f"Instrument '{self.instrument}' could not be found in '{self.facility}'. "
+                    f"Valid options: {valid_instruments}"
+                ),
+                stacklevel=1,
+            )
+        # Validating the experiment is expensive and will fail in our CI due to the filesystem not being mounted there.
+
+        return self
+
+    def get_facilities(self) -> List[str]:
+        facilities = list(INSTRUMENTS.keys())
+        if self.allow_custom_directories:
+            facilities.append(CUSTOM_DIRECTORIES_LABEL)
+        return facilities
+
+    def get_instruments(self) -> List[str]:
+        return list(INSTRUMENTS.get(self.facility, {}).keys())
+
+
+class AnalysisDataSelectorModel(NeutronDataSelectorModel):
+    """Analysis cluster filesystem backend for NeutronDataSelector."""
+
+    def __init__(self, state: AnalysisDataSelectorState) -> None:
+        super().__init__(state)
+        self.state: AnalysisDataSelectorState = state
+
+    def set_binding_parameters(self, **kwargs: Any) -> None:
+        super().set_binding_parameters(**kwargs)
+
+        if "allow_custom_directories" in kwargs:
+            self.state.allow_custom_directories = kwargs["allow_custom_directories"]
+
+    def get_custom_directory_path(self) -> Optional[Path]:
+        # Don't expose the full file system
+        if not self.state.custom_directory:
+            return None
+
+        return Path(self.state.custom_directory)
+
+    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_instrument_dir(self) -> str:
+        return INSTRUMENTS.get(self.state.facility, {}).get(self.state.instrument, "")
+
+    def get_experiments(self) -> List[str]:
+        experiments = []
+
+        instrument_path = Path("/") / self.state.facility / self.get_instrument_dir()
+        try:
+            for dirname in os.listdir(instrument_path):
+                if dirname.startswith("IPTS-") and os.access(instrument_path / dirname, mode=os.R_OK):
+                    experiments.append(dirname)
+        except OSError:
+            pass
+
+        return natsorted(experiments)
+
+    def get_directories(self, base_path: Optional[Path] = None) -> List[Dict[str, Any]]:
+        using_custom_directory = self.state.facility == CUSTOM_DIRECTORIES_LABEL
+        if base_path:
+            pass
+        elif using_custom_directory:
+            base_path = self.get_custom_directory_path()
+        else:
+            base_path = self.get_experiment_directory_path()
+
+        if not base_path:
+            return []
+
+        return self.get_directories_from_path(base_path)
+
+    def get_datafiles(self, *args: Any, **kwargs: Any) -> List[Any]:
+        using_custom_directory = self.state.facility == CUSTOM_DIRECTORIES_LABEL
+        if self.state.experiment:
+            base_path = Path("/") / self.state.facility / self.get_instrument_dir() / self.state.experiment
+        elif using_custom_directory and self.state.custom_directory:
+            base_path = Path(self.state.custom_directory)
+        else:
+            return []
+
+        return [{"path": path} for path in self.get_datafiles_from_path(base_path)]

nova/trame/model/ornl/neutron_data_selector.py

@@ -1,72 +1,20 @@
 """Model implementation for DataSelector."""
 
-import os
 from pathlib import Path
 from typing import Any, Dict, List, Optional
-from warnings import warn
 
 from natsort import natsorted
-from pydantic import Field, field_validator, model_validator
-from typing_extensions import Self
+from pydantic import Field, field_validator
 
 from ..data_selector import DataSelectorModel, DataSelectorState
 
-CUSTOM_DIRECTORIES_LABEL = "Custom Directory"
-
-INSTRUMENTS = {
-    "HFIR": {
-        "CG-1A": "CG1A",
-        "CG-1B": "CG1B",
-        "CG-1D": "CG1D",
-        "CG-2": "CG2",
-        "CG-3": "CG3",
-        "CG-4B": "CG4B",
-        "CG-4C": "CG4C",
-        "CG-4D": "CG4D",
-        "HB-1": "HB1",
-        "HB-1A": "HB1A",
-        "HB-2A": "HB2A",
-        "HB-2B": "HB2B",
-        "HB-2C": "HB2C",
-        "HB-3": "HB3",
-        "HB-3A": "HB3A",
-        "NOW-G": "NOWG",
-        "NOW-V": "NOWV",
-    },
-    "SNS": {
-        "BL-18": "ARCS",
-        "BL-0": "BL0",
-        "BL-2": "BSS",
-        "BL-5": "CNCS",
-        "BL-9": "CORELLI",
-        "BL-6": "EQSANS",
-        "BL-14B": "HYS",
-        "BL-11B": "MANDI",
-        "BL-1B": "NOM",
-        "NOW-G": "NOWG",
-        "BL-15": "NSE",
-        "BL-11A": "PG3",
-        "BL-4B": "REF_L",
-        "BL-4A": "REF_M",
-        "BL-17": "SEQ",
-        "BL-3": "SNAP",
-        "BL-12": "TOPAZ",
-        "BL-1A": "USANS",
-        "BL-10": "VENUS",
-        "BL-16B": "VIS",
-        "BL-7": "VULCAN",
-    },
-}
-
 
 class NeutronDataSelectorState(DataSelectorState):
     """Selection state for identifying datafiles."""
 
-    allow_custom_directories: bool = Field(default=False)
     facility: str = Field(default="", title="Facility")
     instrument: str = Field(default="", title="Instrument")
     experiment: str = Field(default="", title="Experiment")
-    custom_directory: str = Field(default="", title="Custom Directory")
 
     @field_validator("experiment", mode="after")
     @classmethod
@@ -75,33 +23,11 @@ class NeutronDataSelectorState(DataSelectorState):
             raise ValueError("experiment must begin with IPTS-")
         return experiment
 
-    @model_validator(mode="after")
-    def validate_state(self) -> Self:
-        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 = self.get_instruments()
-        if self.instrument and self.facility != CUSTOM_DIRECTORIES_LABEL and self.instrument not in valid_instruments:
-            warn(
-                (
-                    f"Instrument '{self.instrument}' could not be found in '{self.facility}'. "
-                    f"Valid options: {valid_instruments}"
-                ),
-                stacklevel=1,
-            )
-        # Validating the experiment is expensive and will fail in our CI due to the filesystem not being mounted there.
-
-        return self
-
     def get_facilities(self) -> List[str]:
-        facilities = list(INSTRUMENTS.keys())
-        if self.allow_custom_directories:
-            facilities.append(CUSTOM_DIRECTORIES_LABEL)
-        return facilities
+        raise NotImplementedError()
 
     def get_instruments(self) -> List[str]:
-        return list(INSTRUMENTS.get(self.facility, {}).keys())
+        raise NotImplementedError()
 
 
 class NeutronDataSelectorModel(DataSelectorModel):
@@ -120,65 +46,18 @@ class NeutronDataSelectorModel(DataSelectorModel):
             self.state.instrument = kwargs["instrument"]
         if "experiment" in kwargs:
             self.state.experiment = kwargs["experiment"]
-        if "allow_custom_directories" in kwargs:
-            self.state.allow_custom_directories = kwargs["allow_custom_directories"]
 
     def get_facilities(self) -> List[str]:
         return natsorted(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 natsorted(self.state.get_instruments())
 
     def get_experiments(self) -> List[str]:
-        experiments = []
-
-        instrument_path = Path("/") / self.state.facility / self.get_instrument_dir()
-        try:
-            for dirname in os.listdir(instrument_path):
-                if dirname.startswith("IPTS-") and os.access(instrument_path / dirname, mode=os.R_OK):
-                    experiments.append(dirname)
-        except OSError:
-            pass
-
-        return natsorted(experiments)
-
-    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_custom_directory_path(self) -> Optional[Path]:
-        # Don't expose the full file system
-        if not self.state.custom_directory:
-            return None
-
-        return Path(self.state.custom_directory)
+        raise NotImplementedError()
 
     def get_directories(self, base_path: Optional[Path] = None) -> List[Dict[str, Any]]:
-        using_custom_directory = self.state.facility == CUSTOM_DIRECTORIES_LABEL
-        if base_path:
-            pass
-        elif using_custom_directory:
-            base_path = self.get_custom_directory_path()
-        else:
-            base_path = self.get_experiment_directory_path()
-
-        if not base_path:
-            return []
-
-        return self.get_directories_from_path(base_path)
-
-    def get_datafiles(self) -> List[str]:
-        using_custom_directory = self.state.facility == CUSTOM_DIRECTORIES_LABEL
-        if self.state.experiment:
-            base_path = Path("/") / self.state.facility / self.get_instrument_dir() / self.state.experiment
-        elif using_custom_directory and self.state.custom_directory:
-            base_path = Path(self.state.custom_directory)
-        else:
-            return []
-
-        return self.get_datafiles_from_path(base_path)
+        raise NotImplementedError()
+
+    def get_datafiles(self, *args: Any, **kwargs: Any) -> List[str]:
+        raise NotImplementedError()

nova/trame/model/ornl/oncat_data_selector.py

@@ -0,0 +1,131 @@
+"""ONCat backend for NeutronDataSelector."""
+
+import os
+from pathlib import Path
+from typing import Any, Dict, List, Optional
+
+from natsort import natsorted
+from pydantic import Field
+from pyoncat import CLIENT_CREDENTIALS_FLOW, ONCat
+
+from .neutron_data_selector import NeutronDataSelectorModel, NeutronDataSelectorState
+
+TOKEN_VARNAME = "USER_OIDC_TOKEN"
+ID_VARNAME = "ONCAT_CLIENT_ID"
+SECRET_VARNAME = "ONCAT_CLIENT_SECRET"
+
+
+class ONCatDataSelectorState(NeutronDataSelectorState):
+    """Selection state for identifying datafiles."""
+
+    instrument_mapping: Dict[str, str] = Field(default={})
+    projection: List[str] = Field(default=[])
+
+
+class ONCatDataSelectorModel(NeutronDataSelectorModel):
+    """ONCat backend for NeutronDataSelector."""
+
+    def __init__(self, state: ONCatDataSelectorState) -> None:
+        super().__init__(state)
+        self.state: ONCatDataSelectorState = state
+
+        user_token = os.environ.get(TOKEN_VARNAME, "")
+        client_id = os.environ.get(ID_VARNAME, "")
+        client_secret = os.environ.get(SECRET_VARNAME, "")
+        if user_token:
+            self.oncat_client = ONCat(url="https://calvera-test.ornl.gov/oncat", api_token=user_token)
+        elif client_id and client_secret:
+            self.oncat_client = ONCat(
+                url="https://oncat.ornl.gov",
+                client_id=client_id,
+                client_secret=client_secret,
+                flow=CLIENT_CREDENTIALS_FLOW,
+            )
+        else:
+            raise EnvironmentError(
+                f"In order to use the ONCat backend for NeutronDataSelector, you must set either {TOKEN_VARNAME} or "
+                f"both {ID_VARNAME} and {SECRET_VARNAME} in your environment."
+            )
+
+    def set_binding_parameters(self, **kwargs: Any) -> None:
+        super().set_binding_parameters(**kwargs)
+
+        if "projection" in kwargs:
+            self.state.projection = kwargs["projection"]
+
+    def get_facilities(self) -> List[str]:
+        facilities = []
+        for facility_data in self.oncat_client.Facility.list(projection=["name"]):
+            facilities.append(facility_data.name)
+        return natsorted(facilities)
+
+    def get_instruments(self) -> List[str]:
+        if not self.state.facility:
+            return []
+
+        self.state.instrument_mapping = {}
+        instruments = []
+        for instrument_data in self.oncat_client.Instrument.list(
+            facility=self.state.facility, projection=["short_name"]
+        ):
+            self.state.instrument_mapping[instrument_data.short_name] = instrument_data.id
+            instruments.append(instrument_data.short_name)
+        return natsorted(instruments)
+
+    def get_experiments(self) -> List[str]:
+        if not self.state.facility or not self.state.instrument:
+            return []
+
+        experiments = []
+        for experiment_data in self.oncat_client.Experiment.list(
+            facility=self.state.facility,
+            instrument=self.state.instrument_mapping[self.state.instrument],
+            projection=["name"],
+        ):
+            experiments.append(experiment_data.name)
+        return natsorted(experiments)
+
+    def get_directories(self, _: Optional[Path] = None) -> List[Dict[str, Any]]:
+        return []
+
+    def create_datafile_obj(self, data: Dict[str, Any], projection: List[str]) -> Dict[str, str]:
+        new_obj = {"path": data["location"]}
+
+        for key in projection:
+            value: Any = data
+
+            if key == "location":
+                continue
+
+            for part in key.split("."):
+                try:
+                    value = value[part]
+                except KeyError:
+                    value = ""
+                    break
+
+            new_obj[key] = value
+
+        return new_obj
+
+    def get_datafiles(self, *args: Any, **kwargs: Any) -> List[Any]:
+        if not self.state.facility or not self.state.instrument or not self.state.experiment:
+            return []
+
+        projection = ["location"] + self.state.projection
+
+        datafiles = []
+        for datafile_data in self.oncat_client.Datafile.list(
+            facility=self.state.facility,
+            instrument=self.state.instrument_mapping[self.state.instrument],
+            experiment=self.state.experiment,
+            projection=projection,
+        ):
+            path = datafile_data.location
+            if self.state.extensions:
+                for extension in self.state.extensions:
+                    if path.lower().endswith(extension):
+                        datafiles.append(self.create_datafile_obj(datafile_data, projection))
+            else:
+                datafiles.append(self.create_datafile_obj(datafile_data, projection))
+        return natsorted(datafiles, key=lambda d: d["path"])

nova/trame/view/components/data_selector.py

@@ -155,10 +155,10 @@ class DataSelector(datagrid.VGrid):
                         )
                         vuetify.VListItem("No directories found", classes="flex-0-1 text-center", v_else=True)
 
-                super().__init__(
-                    v_model=self._v_model,
-                    can_focus=False,
-                    columns=(
+                if "columns" in kwargs:
+                    columns = kwargs.pop("columns")
+                else:
+                    columns = (
                         "[{"
                         "    cellTemplate: (createElement, props) =>"
                         f"       window.grid_manager.get('{self._revogrid_id}').cellTemplate(createElement, props),"
@@ -167,7 +167,12 @@ class DataSelector(datagrid.VGrid):
                         "    name: 'Available Datafiles',"
                         "    prop: 'title',"
                         "}]",
-                    ),
+                    )
+
+                super().__init__(
+                    v_model=self._v_model,
+                    can_focus=False,
+                    columns=columns,
                     column_span=1 if isinstance(self._subdirectory, tuple) or not self._subdirectory else 2,
                     frame_size=10,
                     hide_attribution=True,

nova/trame/view/components/file_upload.py

@@ -21,6 +21,7 @@ class FileUpload(vuetify.VBtn):
         extensions: Union[List[str], Tuple, None] = None,
         label: str = "",
         return_contents: Union[bool, Tuple] = True,
+        use_bytes: Union[bool, Tuple] = False,
         **kwargs: Any,
     ) -> None:
         """Constructor for FileUpload.
@@ -40,6 +41,8 @@ class FileUpload(vuetify.VBtn):
         return_contents : Union[bool, Tuple], optional
             If true, the file contents will be stored in v_model. If false, a file path will be stored in v_model.
             Defaults to true.
+        use_bytes : Union[bool, Tuple], optional
+            If true, then files uploaded from the local machine will contain bytes rather than text.
         **kwargs
             All other arguments will be passed to the underlying
             `Button component <https://trame.readthedocs.io/en/latest/trame.widgets.vuetify3.html#trame.widgets.vuetify3.VBtn>`_.
@@ -54,6 +57,7 @@ class FileUpload(vuetify.VBtn):
         self._base_paths = base_paths if base_paths else ["/"]
         self._extensions = extensions if extensions else []
         self._return_contents = return_contents
+        self._use_bytes = use_bytes
         self._ref_name = f"nova__fileupload_{self._next_id}"
 
         super().__init__(label, **kwargs)
@@ -83,6 +87,7 @@ class FileUpload(vuetify.VBtn):
             extensions=self._extensions,
             input_props={"classes": "d-none"},
             return_contents=self._return_contents,
+            use_bytes=self._use_bytes,
         )
 
         with self:

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

@@ -1,6 +1,6 @@
 """View Implementation for DataSelector."""
 
-from typing import Any, List, Tuple, Union
+from typing import Any, List, Literal, Tuple, Union
 from warnings import warn
 
 from trame.app import get_server
@@ -8,11 +8,13 @@ from trame.widgets import vuetify3 as vuetify
 
 from nova.mvvm._internal.utils import rgetdictvalue
 from nova.mvvm.trame_binding import TrameBinding
-from nova.trame.model.ornl.neutron_data_selector import (
+from nova.trame.model.ornl.analysis_data_selector import (
     CUSTOM_DIRECTORIES_LABEL,
-    NeutronDataSelectorModel,
-    NeutronDataSelectorState,
+    AnalysisDataSelectorModel,
+    AnalysisDataSelectorState,
 )
+from nova.trame.model.ornl.neutron_data_selector import NeutronDataSelectorModel
+from nova.trame.model.ornl.oncat_data_selector import ONCatDataSelectorModel, ONCatDataSelectorState
 from nova.trame.view.layouts import GridLayout
 from nova.trame.view_model.ornl.neutron_data_selector import NeutronDataSelectorViewModel
 
@@ -29,10 +31,12 @@ class NeutronDataSelector(DataSelector):
         self,
         v_model: Union[str, Tuple],
         allow_custom_directories: Union[bool, Tuple] = False,
+        data_source: Literal["filesystem", "oncat"] = "filesystem",
         facility: Union[str, Tuple] = "",
         instrument: Union[str, Tuple] = "",
         experiment: Union[str, Tuple] = "",
         extensions: Union[List[str], Tuple, None] = None,
+        projection: Union[List[str], Tuple, None] = None,
         subdirectory: Union[str, Tuple] = "",
         refresh_rate: Union[int, Tuple] = 30,
         select_strategy: Union[str, Tuple] = "all",
@@ -48,6 +52,11 @@ class NeutronDataSelector(DataSelector):
         allow_custom_directories : Union[bool, Tuple], optional
             Whether or not to allow users to provide their own directories to search for datafiles in. Ignored if the
             facility parameter is set.
+        data_source : Literal["filesystem", "oncat"], optional
+            The source from which to pull datafiles. Defaults to "filesystem". If using ONCat, you will need to set the
+            following environment variables for local development: `ONCAT_CLIENT_ID` and `ONCAT_CLIENT_SECRET`. Note
+            that this parameter does not supporting Trame bindings. If you need to swap between the options, please
+            create two instances of this class and switch between them using a v_if or a v_show.
         facility : Union[str, Tuple], optional
             The facility to restrict data selection to. Options: HFIR, SNS
         instrument : Union[str, Tuple], optional
@@ -56,6 +65,9 @@ class NeutronDataSelector(DataSelector):
             The experiment to restrict data selection to.
         extensions : Union[List[str], Tuple], optional
             A list of file extensions to restrict selection to. If unset, then all files will be shown.
+        projection : Union[List[str], Tuple], optional
+            Sets the projection argument when pulling data files via pyoncat. Please refer to the ONCat documentation
+            for how to use this. This should only be used with `data_source="oncat"`.
         subdirectory : Union[str, Tuple], optional
             A subdirectory within the user's chosen experiment to show files. If not specified as a string, the user
             will be shown a folder browser and will be able to see all files in the experiment that they have access to.
@@ -73,6 +85,12 @@ class NeutronDataSelector(DataSelector):
         -------
         None
         """
+        if data_source == "oncat" and allow_custom_directories:
+            warn("allow_custom_directories will be ignored since data will be pulled from ONCat.", stacklevel=1)
+
+        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:
             warn("allow_custom_directories will be ignored since the facility parameter is fixed.", stacklevel=1)
 
@@ -81,6 +99,8 @@ class NeutronDataSelector(DataSelector):
         self._experiment = experiment
         self._allow_custom_directories = allow_custom_directories
         self._last_allow_custom_directories = self._allow_custom_directories
+        self._data_source = data_source
+        self._projection = projection
 
         self._state_name = f"nova__dataselector_{self._next_id}_state"
         self._facilities_name = f"nova__neutrondataselector_{self._next_id}_facilities"
@@ -100,19 +120,43 @@ class NeutronDataSelector(DataSelector):
             v_model,
             "",
             extensions=extensions,
-            subdirectory=subdirectory,
+            subdirectory=subdirectory if data_source == "filesystem" else "oncat",
             refresh_rate=refresh_rate,
             select_strategy=select_strategy,
             **kwargs,
         )
 
+    def create_projection_column_title(self, key: str) -> str:
+        return key.split(".")[-1].replace("_", " ").title()
+
     def create_ui(self, **kwargs: Any) -> None:
-        super().create_ui(**kwargs)
+        if self._data_source == "oncat":
+            columns = (
+                "["
+                "  {"
+                "    cellTemplate: (createElement, props) =>"
+                f"     window.grid_manager.get('{self._revogrid_id}').cellTemplate(createElement, props),"
+                "    columnTemplate: (createElement) =>"
+                f"     window.grid_manager.get('{self._revogrid_id}').columnTemplate(createElement),"
+                "    name: 'Available Datafiles',"
+                "    prop: 'title',"
+                "    size: 150,"
+                "  },"
+            )
+            if self._projection:
+                for key in self._projection:
+                    columns += f"{{name: '{self.create_projection_column_title(key)}', prop: '{key}', size: 150}},"
+            columns += "]"
+
+            super().create_ui(columns=(columns,), resize=True, **kwargs)
+        else:
+            super().create_ui(**kwargs)
+
         with self._layout.filter:
             with GridLayout(columns=3):
-                columns = 3
+                column_span = 3
                 if isinstance(self._facility, tuple) or not self._facility:
-                    columns -= 1
+                    column_span -= 1
                     InputField(
                         v_model=self._selected_facility_name,
                         items=(self._facilities_name,),
@@ -120,7 +164,7 @@ class NeutronDataSelector(DataSelector):
                         update_modelValue=(self.update_facility, "[$event]"),
                     )
                 if isinstance(self._instrument, tuple) or not self._instrument:
-                    columns -= 1
+                    column_span -= 1
                     InputField(
                         v_if=f"{self._selected_facility_name} !== '{CUSTOM_DIRECTORIES_LABEL}'",
                         v_model=self._selected_instrument_name,
@@ -131,7 +175,7 @@ class NeutronDataSelector(DataSelector):
                 InputField(
                     v_if=f"{self._selected_facility_name} !== '{CUSTOM_DIRECTORIES_LABEL}'",
                     v_model=self._selected_experiment_name,
-                    column_span=columns,
+                    column_span=column_span,
                     items=(self._experiments_name,),
                     type="autocomplete",
                     update_modelValue=(self.update_experiment, "[$event]"),
@@ -139,8 +183,11 @@ class NeutronDataSelector(DataSelector):
                 InputField(v_else=True, v_model=f"{self._state_name}.custom_directory", column_span=2)
 
     def _create_model(self) -> None:
-        state = NeutronDataSelectorState()
-        self._model: NeutronDataSelectorModel = NeutronDataSelectorModel(state)
+        self._model: NeutronDataSelectorModel
+        if self._data_source == "oncat":
+            self._model = ONCatDataSelectorModel(ONCatDataSelectorState())
+        else:
+            self._model = AnalysisDataSelectorModel(AnalysisDataSelectorState())
 
     def _create_viewmodel(self) -> None:
         server = get_server(None, client_type="vue3")
@@ -167,6 +214,7 @@ class NeutronDataSelector(DataSelector):
         set_state_param(self.state, self._instrument)
         set_state_param(self.state, self._experiment)
         set_state_param(self.state, self._allow_custom_directories)
+        set_state_param(self.state, self._projection)
         self._last_facility = get_state_param(self.state, self._facility)
         self._last_instrument = get_state_param(self.state, self._instrument)
         self._last_experiment = get_state_param(self.state, self._experiment)
@@ -175,6 +223,7 @@ class NeutronDataSelector(DataSelector):
             instrument=get_state_param(self.state, self._instrument),
             experiment=get_state_param(self.state, self._experiment),
             allow_custom_directories=get_state_param(self.state, self._allow_custom_directories),
+            projection=get_state_param(self.state, self._projection),
         )
 
         # Now we set up the change listeners for all bound parameters. These are responsible for updating the component
@@ -232,6 +281,17 @@ class NeutronDataSelector(DataSelector):
                         )
                     )
 
+        if isinstance(self._projection, tuple):
+
+            @self.state.change(self._projection[0].split(".")[0])
+            def on_projection_change(**kwargs: Any) -> None:
+                projection = rgetdictvalue(kwargs, self._projection[0])  # type: ignore
+                if projection != self._projection:
+                    self._projection = projection
+                    self._vm.set_binding_parameters(
+                        projection=set_state_param(self.state, self._projection, projection)
+                    )
+
     # These update methods notify the rest of the application when the component changes bound parameters.
     def update_facility(self, facility: str) -> None:
         self._vm.set_binding_parameters(
@@ -257,3 +317,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/remote_file_input.py

@@ -12,7 +12,7 @@ from trame_server.core import State
 
 from nova.mvvm._internal.utils import rgetdictvalue
 from nova.mvvm.trame_binding import TrameBinding
-from nova.trame._internal.utils import get_state_name, set_state_param
+from nova.trame._internal.utils import get_state_name, get_state_param, set_state_param
 from nova.trame.model.remote_file_input import RemoteFileInputModel
 from nova.trame.view_model.remote_file_input import RemoteFileInputViewModel
 
@@ -35,6 +35,7 @@ class RemoteFileInput:
         extensions: Union[List[str], Tuple, None] = None,
         input_props: Optional[dict[str, Any]] = None,
         return_contents: Union[bool, Tuple] = False,
+        use_bytes: Union[bool, Tuple] = False,
     ) -> None:
         """Constructor for RemoteFileInput.
 
@@ -58,6 +59,8 @@ class RemoteFileInput:
         return_contents : Union[bool, Tuple], optional
             If true, then the v_model will contain the contents of the file. If false, then the v_model will contain the
             path of the file. Defaults to false.
+        use_bytes : Union[bool, Tuple], optional
+            If true, then the file contents will be treated as bytestreams when calling decode_file.
 
         Returns
         -------
@@ -73,6 +76,7 @@ class RemoteFileInput:
         self.extensions = extensions if extensions else []
         self.input_props = dict(input_props) if input_props else {}
         self.return_contents = return_contents
+        self.use_bytes = use_bytes
 
         if "__events" not in self.input_props:
             self.input_props["__events"] = []
@@ -286,14 +290,22 @@ class RemoteFileInput:
             self.decode_file(file.read())
 
     def decode_file(self, bytestream: bytes, set_contents: bool = False) -> None:
+        use_bytes = get_state_param(self.state, self.use_bytes)
+
         decoded_content = bytestream.decode("latin1")
         if set_contents:
             self.set_v_model(decoded_content)
         else:
-            with NamedTemporaryFile(mode="w", delete=False, encoding="utf-8") as temp_file:
-                temp_file.write(decoded_content)
-                temp_file.flush()
-                self.set_v_model(temp_file.name)
+            if use_bytes:
+                with NamedTemporaryFile(mode="wb", delete=False) as temp_file:
+                    temp_file.write(bytestream)
+                    temp_file.flush()
+                    self.set_v_model(temp_file.name)
+            else:
+                with NamedTemporaryFile(mode="w", delete=False, encoding="utf-8") as temp_file:
+                    temp_file.write(decoded_content)
+                    temp_file.flush()
+                    self.set_v_model(temp_file.name)
 
     def select_file(self, value: str) -> None:
         """Programmatically set the v_model value."""

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

@@ -21,7 +21,7 @@ class RevoGrid {
         const modelValue = _.get(trameState, this.modelKey)
         const availableData = _.get(trameState, this.dataKey)
         const selectAllCheckbox = this.grid.querySelector(".header-content input")
-        const rowCheckboxes = this.grid.querySelectorAll(".rgCell")
+        const rowCheckboxes = this.grid.querySelectorAll(".rgCell:first-child")
 
         if (selectAllCheckbox === null) {
             return

nova/trame/view_model/data_selector.py

@@ -66,6 +66,9 @@ class DataSelectorViewModel:
         self.model.set_subdirectory(subdirectory_path)
         self.update_view()
 
+    def transform_datafiles(self, datafiles: List[Any]) -> List[Dict[str, str]]:
+        return [{"path": datafile, "title": os.path.basename(datafile)} for datafile in datafiles]
+
     def update_view(self, refresh_directories: bool = False) -> None:
         self.state_bind.update_in_view(self.model.state)
         if not self.directories or refresh_directories:
@@ -73,8 +76,6 @@ class DataSelectorViewModel:
             self.reexpand_directories()
         self.directories_bind.update_in_view(self.directories)
 
-        self.datafiles = [
-            {"path": datafile, "title": os.path.basename(datafile)} for datafile in self.model.get_datafiles()
-        ]
+        self.datafiles = self.transform_datafiles(self.model.get_datafiles())
         self.datafiles_bind.update_in_view(self.datafiles)
         self.reset_grid_bind.update_in_view(None)

nova/trame/view_model/ornl/neutron_data_selector.py

@@ -1,6 +1,7 @@
 """View model implementation for the DataSelector widget."""
 
-from typing import Any, Dict
+import os
+from typing import Any, Dict, List
 
 from nova.mvvm.interface import BindingInterface
 from nova.trame.model.ornl.neutron_data_selector import NeutronDataSelectorModel
@@ -33,6 +34,9 @@ class NeutronDataSelectorViewModel(DataSelectorViewModel):
                     self.reset()
                     self.update_view()
 
+    def transform_datafiles(self, datafiles: List[Any]) -> List[Dict[str, str]]:
+        return [{"title": os.path.basename(datafile["path"]), **datafile} for datafile in datafiles]
+
     def update_view(self, refresh_directories: bool = False) -> None:
         self.facilities_bind.update_in_view(self.model.get_facilities())
         self.instruments_bind.update_in_view(self.model.get_instruments())

{nova_trame-0.25.5.dist-info → nova_trame-0.26.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: nova-trame
-Version: 0.25.5
+Version: 0.26.2
 Summary: A Python Package for injecting curated themes and custom components into Trame applications
 License: MIT
 Keywords: NDIP,Python,Trame,Vuetify
@@ -22,6 +22,7 @@ Requires-Dist: natsort (>=8.4.0,<9.0.0)
 Requires-Dist: nova-common (>=0.2.2)
 Requires-Dist: nova-mvvm
 Requires-Dist: pydantic
+Requires-Dist: pyoncat (>=2.1,<3.0)
 Requires-Dist: tomli
 Requires-Dist: tornado (>=6.5.0)
 Requires-Dist: trame

{nova_trame-0.25.5.dist-info → nova_trame-0.26.2.dist-info}/RECORD

@@ -2,17 +2,19 @@ nova/__init__.py,sha256=ED6jHcYiuYpr_0vjGz0zx2lrrmJT9sDJCzIljoDfmlM,65
 nova/trame/__init__.py,sha256=gFrAg1qva5PIqR5TjvPzAxLx103IKipJLqp3XXvrQL8,59
 nova/trame/_internal/utils.py,sha256=lTTJnfqbbIe21Tg2buf5MXqKUEUop7Va5PZgpWMzRkI,1381
 nova/trame/model/data_selector.py,sha256=hPPk1wiJc52jMXP_7XlEur38_vSi9tRUNKIa_gNmblc,4501
-nova/trame/model/ornl/neutron_data_selector.py,sha256=Nkj0DXdv3ydfXV3zeilbOGWuRCVzc_ClAOj6iNnN0uI,6276
+nova/trame/model/ornl/analysis_data_selector.py,sha256=P7IEJdqCAUsEOCof4c2JantPXd9vz0EtvhryEKvscbw,5544
+nova/trame/model/ornl/neutron_data_selector.py,sha256=YMoNEpDKgjP_y18oYj-N9IjkxtqwHz9JYMlURQA4BCE,2148
+nova/trame/model/ornl/oncat_data_selector.py,sha256=3JEkWGMU-esWA9DUTglju9hEP9LyZ7EUXLj1yO5BIDs,4755
 nova/trame/model/remote_file_input.py,sha256=eAk7ZsFgNKcnpJ6KmOQDhiI6pPZpcrr1GMKkRLEWht8,4338
 nova/trame/view/components/__init__.py,sha256=60BeS69aOrFnkptjuD17rfPE1f4Z35iBH56TRmW5MW8,451
-nova/trame/view/components/data_selector.py,sha256=XFwIuKhIeBbkqsNEkIFDhjdDD5PD6cvbgn1jkivUhC4,14817
+nova/trame/view/components/data_selector.py,sha256=T5CFtWPio3YwiPvPEBrWn7vgRo-3l0GqdGKzonc_cwc,14970
 nova/trame/view/components/execution_buttons.py,sha256=Br6uAmE5bY67TTYc5ZTHECNJ_RJqKmv17HAKPpQtbeg,4576
-nova/trame/view/components/file_upload.py,sha256=nRYwTPOzJV_TCtjk337PbeRbbIOf2PipaGKOyj0WKiA,4288
+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=g633Ie3GSNu0QFEuexYl_XUxjUiGEJKjWLP7ZB5PRR0,13122
+nova/trame/view/components/ornl/neutron_data_selector.py,sha256=wVSLmRXiGOv2l-nZ0DgDwjrgTMZDu9e9ECm3k824k3o,16749
 nova/trame/view/components/progress_bar.py,sha256=zhbJwPy_HPQ8YL-ISN8sCRUQ7qY6qqo9wiV59BmvL8I,3038
-nova/trame/view/components/remote_file_input.py,sha256=cXSePj_eP3lf8bRsNEHT7dp-FO3doKkW44J3_9bgPAc,14082
+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
@@ -27,19 +29,19 @@ nova/trame/view/theme/assets/core_style.scss,sha256=3-3qMc5gpaDhfuVWAF_psBH5alxw
 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=81s0fUo8HbHmAyWag7pW0jP796Ttb1noAPOgTJlxJss,4069
+nova/trame/view/theme/assets/js/revo_grid.js,sha256=fbuEWO8etw-xgo9tjJGjJXdd5wL8qpgabPmrnU6Jp8k,4081
 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=8JqSrEbhxK1SccXE1_jUdel9Wtc2QNObVEwtbVWG_QY,13146
 nova/trame/view/utilities/local_storage.py,sha256=vD8f2VZIpxhIKjZwEaD7siiPCTZO4cw9AfhwdawwYLY,3218
-nova/trame/view_model/data_selector.py,sha256=d8qdn6Q2b5fNo5lCXi1LTRdesfmy7wErIvGBa0UjOt8,3075
+nova/trame/view_model/data_selector.py,sha256=jAtq5hpohQ6YiLBbgLJfNUzWZBpN2bjCG_c_FCJu2ns,3186
 nova/trame/view_model/execution_buttons.py,sha256=MfKSp95D92EqpD48C15cBo6dLO0Yld4FeRZMJNxJf7Y,3551
-nova/trame/view_model/ornl/neutron_data_selector.py,sha256=zpwvqETPuw0sEUvv0A2sU5Ha2_BKG_3xFYSaUuixLXw,1579
+nova/trame/view_model/ornl/neutron_data_selector.py,sha256=PIKQyzcHpwu81DNk3d8AfgobDbxbdb9ppRLpEvdPgpw,1778
 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-0.25.5.dist-info/LICENSE,sha256=Iu5QiDbwNbREg75iYaxIJ_V-zppuv4QFuBhAW-qiAlM,1061
-nova_trame-0.25.5.dist-info/METADATA,sha256=l0gN8Orwij-0jFWcK02so7I0YdkoY2DRk897rAE9LMs,1727
-nova_trame-0.25.5.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-nova_trame-0.25.5.dist-info/entry_points.txt,sha256=J2AmeSwiTYZ4ZqHHp9HO6v4MaYQTTBPbNh6WtoqOT58,42
-nova_trame-0.25.5.dist-info/RECORD,,
+nova_trame-0.26.2.dist-info/LICENSE,sha256=Iu5QiDbwNbREg75iYaxIJ_V-zppuv4QFuBhAW-qiAlM,1061
+nova_trame-0.26.2.dist-info/METADATA,sha256=mDqDXOmyd5tFAnh7-VtPdiYu1ij7ajZcanzkgC6Ojps,1763
+nova_trame-0.26.2.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+nova_trame-0.26.2.dist-info/entry_points.txt,sha256=J2AmeSwiTYZ4ZqHHp9HO6v4MaYQTTBPbNh6WtoqOT58,42
+nova_trame-0.26.2.dist-info/RECORD,,