mxcubecore 1.368.0__py3-none-any.whl → 1.370.0__py3-none-any.whl

mxcubecore/HardwareObjects/MAXIV/MicroMAX/beamline.py

@@ -0,0 +1,51 @@
+"""Custom MicroMAX Beamline object.
+
+Adds support for `sample_delivery` configurable, which
+specifies the sample delivery mode for MXCuBE.
+
+Following sample delivery modes are supported:
+
+* osc - Oscillation sample delivery
+* hve - HVE (injector) sample delivery
+
+Example of `sample_delivery` configuration::
+
+  configuration:
+    sample_delivery: osc
+"""
+
+from enum import Enum
+
+import mxcubecore.HardwareObjects.MAXIV.beamline
+
+
+class SampleDelivery(Enum):
+    osc = "osc"
+    hve = "hve"
+
+
+class Beamline(mxcubecore.HardwareObjects.MAXIV.beamline.Beamline):
+    def __init__(self, name):
+        super().__init__(name)
+
+        # 'cached' Sample Delivery mode config
+        self._sample_delivery = None
+
+    #
+    # 'sample_delivery' config
+    #
+
+    def _load_sample_delivery(self):
+        val = self.get_property("sample_delivery", SampleDelivery.osc.value)
+        self._sample_delivery = SampleDelivery(val)
+
+    @property
+    def sample_delivery(self) -> SampleDelivery:
+        if self._sample_delivery is None:
+            self._load_sample_delivery()
+
+        return self._sample_delivery
+
+    def is_hve_sample_delivery(self) -> bool:
+        """True when HVE sample delivery mode is configured."""
+        return self.sample_delivery == SampleDelivery.hve

mxcubecore/HardwareObjects/MAXIV/beamline.py

@@ -0,0 +1,28 @@
+"""Custom MAXIV Beamline object.
+
+Adds support for ``emulate`` configurable, which allows to specify
+features to be emulated at the beamline.
+
+Emulation of following features are supported:
+
+* safety_shutter - emulate safety shutter opening
+* detector_cover - emulate detector cover opening
+* detector_motion - emulate detector distance moves
+
+Example of ``emulate`` configuration::
+
+  configuration:
+    emulate:
+      safety_shutter: true
+      detector_cover: true
+      detector_motion: true
+"""
+
+import mxcubecore.HardwareObjects.Beamline
+
+
+class Beamline(mxcubecore.HardwareObjects.Beamline.Beamline):
+    def emulate(self, feature: str) -> bool:
+        """Check if some feature should be emulated."""
+        emulate = self.get_property("emulate", {})
+        return emulate.get(feature, False)

mxcubecore/HardwareObjects/MAXIV/session.py

@@ -0,0 +1,158 @@
+"""MAXIV Session hardware object."""
+
+import time
+from pathlib import Path
+
+from sdm import storage
+
+import mxcubecore.HardwareObjects.Session
+from mxcubecore.model.queue_model_objects import PathTemplate
+
+
+class Session(mxcubecore.HardwareObjects.Session.Session):
+    def init(self):
+        super().init()
+        self.is_commissioning = False
+
+        # We initialize with an empty archive_folder,
+        # to be set once proposal is selected.
+        PathTemplate.set_archive_path(self.base_archive_directory, "")
+
+    def set_in_commissioning(self, proposal_info):
+        self.proposal_code = proposal_info["Proposal"]["code"]
+        self.proposal_number = proposal_info["Proposal"]["number"]
+        self.is_commissioning = True
+
+    def get_proposal(self) -> str:
+        """
+        Returns:
+            The proposal, 'local-user' if no proposal is available
+        """
+        proposal = "local-user"
+
+        if self.proposal_code and self.proposal_number:
+            if self.proposal_code == "ifx":
+                self.proposal_code = "fx"
+
+            proposal = str(self.proposal_number)
+
+        return proposal
+
+    def get_base_data_directory(self) -> str:
+        """Get base data directory.
+
+        Figure out the base data directory taking the 'contextual'
+        information into account, such as if the current user
+        is in-house.
+
+        Returns:
+            The base data path.
+        """
+        # /data/(user-type)/(beamline)/(proposal)/(visit)/raw
+        if self.session_start_date:
+            start_time = self.session_start_date.split(" ")[0].replace("-", "")
+        else:
+            start_time = time.strftime("%Y%m%d")
+        _proposal = self.get_proposal()
+
+        if not self.is_commissioning:
+            if self.is_proprietary():
+                directory = Path(
+                    self.base_directory,
+                    "proprietary",
+                    self.beamline_name.lower(),
+                    _proposal,
+                    start_time,
+                )
+            else:
+                directory = Path(
+                    self.base_directory,
+                    "visitors",
+                    self.beamline_name.lower(),
+                    _proposal,
+                    start_time,
+                )
+        else:
+            # /data/staff/biomax/commissioning/date
+            directory = Path(
+                self.base_directory,
+                "staff",
+                self.beamline_name.lower(),
+                "commissioning",
+                time.strftime("%Y%m%d"),
+            )
+
+        self.log.info(
+            "Data directory for proposal %s: %s",
+            self.get_proposal(),
+            directory,
+        )
+
+        return str(directory)
+
+    def prepare_directories(self, session):
+        self.log.info("Preparing Data directory for session: %s", session)
+        start_date = session.start_datetime.date().isoformat().replace("-", "")
+        self.set_session_start_date(start_date)
+
+        self.log.info("Preparing Data directory for proposal %s", self.get_proposal())
+        if self.is_commissioning:
+            category = "staff"
+        elif self.is_proprietary():
+            category = "proprietary"
+        else:
+            category = "visitors"
+
+        try:
+            self.storage = storage.Storage(
+                user_type=category, beamline=self.endstation_name
+            )
+        except Exception:
+            self.log.exception("error setting up SDM")
+
+        # This creates the path for the data and ensures proper permissions
+        # e.g. /data/visitors/biomax/<proposal>/<visit>/{raw, process}
+        if self.is_commissioning:
+            group = self.beamline_name.lower()
+        else:
+            group = self.storage.get_proposal_group(session.number)
+        try:
+            _raw_path = self.storage.create_path(
+                session.number, group, self.get_session_start_date()
+            )
+
+            self.log.info("SDM Data directory created: %s", _raw_path)
+        except Exception as exc:  # noqa: BLE001
+            self.log.warning("SDM Data directory creation failed. %s", exc)
+            self.log.info("SDM Data directory trying to create again after failure")
+            time.sleep(0.1)
+            try:
+                _raw_path = self.storage.create_path(
+                    session.number, group, self.get_session_start_date()
+                )
+
+                self.log.info("SDM Data directory created: %s", _raw_path)
+            except Exception:
+                self.log.exception("SDM Data directory creation failed.")
+                raise
+
+        if self.base_archive_directory:
+            archive_folder = "{}/{}".format(category, self.beamline_name.lower())
+            PathTemplate.set_archive_path(self.base_archive_directory, archive_folder)
+            _archive_path = Path(self.base_archive_directory, archive_folder)
+            self.log.info("Archive directory configured: %s", _archive_path)
+
+    def is_proprietary(self) -> bool:
+        """Determines if current proposal is considered to be proprietary.
+
+        Returns:
+            True if the proposal is proprietary, otherwise False.
+        """
+        return self.proposal_code == "IN"
+
+    def clear_session(self):
+        self.session_id = None
+        self.proposal_code = None
+        self.proposal_number = None
+        self.proposal_id = None
+        self.is_commissioning = False

{mxcubecore-1.368.0.dist-info → mxcubecore-1.370.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: mxcubecore
-Version: 1.368.0
+Version: 1.370.0
 Summary: Core libraries for the MXCuBE application
 License: LGPL-3.0-or-later
 Keywords: mxcube,mxcube3,mxcubecore

{mxcubecore-1.368.0.dist-info → mxcubecore-1.370.0.dist-info}/RECORD

@@ -224,10 +224,12 @@ mxcubecore/HardwareObjects/LimaPilatusDetector.py,sha256=yUcUi7OXdoy4TU2aZN21kc6
 mxcubecore/HardwareObjects/MAXIV/ISPyBLims.py,sha256=iKgpb0NVGIN-iRgjIpV2eh12PJoAZvo3NFyKwo-458Q,7565
 mxcubecore/HardwareObjects/MAXIV/MAXIVAutoProcessing.py,sha256=kgTSnOLoumPtOUazJeg6N_no1WOScPeLwus3iR1xMPw,9201
 mxcubecore/HardwareObjects/MAXIV/MachInfo.py,sha256=Wkj5JHP_8tOgRGNXiKPfImTsX-O67_CrWH3wP14AsSI,2983
-mxcubecore/HardwareObjects/MAXIV/MaxIVSession.py,sha256=DR9jnTSX_i2Ljs2iBIBeyZkcf7P284fJd_mUtU4bPi0,7732
 mxcubecore/HardwareObjects/MAXIV/MicroMAX/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mxcubecore/HardwareObjects/MAXIV/MicroMAX/beamline.py,sha256=QfNp5ecE4l54cU2U8Km7sK4lgenSnZeBmkxTyRCiaLE,1272
 mxcubecore/HardwareObjects/MAXIV/MicroMAX/beamline_actions.py,sha256=mQUoWJD8NU8N_dyGLGTAD4MJ9sD6B6CYw5EuDZQFhkQ,2085
 mxcubecore/HardwareObjects/MAXIV/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mxcubecore/HardwareObjects/MAXIV/beamline.py,sha256=Np98l0aThwHZvgHbkvkWXz7RIIkWzY_ArDmddoyfIus,803
+mxcubecore/HardwareObjects/MAXIV/session.py,sha256=mqsolRmXkOkmItr8jH48G3NdJ6GzVJ_a85SF4VaiLkA,5431
 mxcubecore/HardwareObjects/MD2Motor.py,sha256=N5d6iOgqw5k9e27lTKUOrpSbEMeNdTgWhNUgYzR0w5k,5639
 mxcubecore/HardwareObjects/MD3UP.py,sha256=zC-TmPruj2HRO6cMGDBDS9s8bXor19jhvb_oux1Ihh8,14528
 mxcubecore/HardwareObjects/MachCurrent.py,sha256=4pxVm7PaSylwPs7Ak0Fgo36NW2ipYCrPbp83KKl78z8,3502
@@ -467,8 +469,8 @@ mxcubecore/utils/conversion.py,sha256=G1bk2Mi2ZwGbZa5pEeiFaKWxhSVXVGqu1L9_SioyUO
 mxcubecore/utils/qt_import.py,sha256=0lPmqok_oYQZ059kJCq7RWdg490T8YKyRvoZGyWDy4M,14486
 mxcubecore/utils/tango.py,sha256=lAl7Su_GgyXFEEKZ1yu_2gU18wXHVaBbGR8RYcIOVYk,2100
 mxcubecore/utils/units.py,sha256=Gh7ovTUN00XBMUoyDG5W7akCx1pROL-M6pK2z1ouemg,1361
-mxcubecore-1.368.0.dist-info/COPYING,sha256=u-Mc8zCecwyo4YoP8UulmzCiZZ_MmCLROd_NBtOcRj0,35148
-mxcubecore-1.368.0.dist-info/COPYING.LESSER,sha256=46mU2C5kSwOnkqkw9XQAJlhBL2JAf1_uCD8lVcXyMRg,7652
-mxcubecore-1.368.0.dist-info/METADATA,sha256=WGJ3I5eYDbJNtgzQnUz-xYIlidaanR3tTaUwfdsxU64,4259
-mxcubecore-1.368.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-mxcubecore-1.368.0.dist-info/RECORD,,
+mxcubecore-1.370.0.dist-info/COPYING,sha256=u-Mc8zCecwyo4YoP8UulmzCiZZ_MmCLROd_NBtOcRj0,35148
+mxcubecore-1.370.0.dist-info/COPYING.LESSER,sha256=46mU2C5kSwOnkqkw9XQAJlhBL2JAf1_uCD8lVcXyMRg,7652
+mxcubecore-1.370.0.dist-info/METADATA,sha256=LpkHXXmiDnrsb-M1oPqAe-BdTH5uqJh0GGbC0yPbNQ0,4259
+mxcubecore-1.370.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+mxcubecore-1.370.0.dist-info/RECORD,,

mxcubecore/HardwareObjects/MAXIV/MaxIVSession.py

@@ -1,231 +0,0 @@
-"""
-MAXIV Session hardware object.
-
-Adapting from original Session.py to adapt the names of data directories
-"""
-
-import logging
-import os
-import socket
-import time
-
-try:
-    from sdm import (
-        storage,
-    )
-except Exception:
-    raise Exception("Cannot import SDM library.")
-
-from mxcubecore.HardwareObjects.Session import Session
-from mxcubecore.model import queue_model_objects
-
-
-class MaxIVSession(Session):
-    def __init__(self, name):
-        Session.__init__(self, name)
-
-    # Framework-2 method, inherited from HardwareObject and called
-    # by the framework after the object has been initialized.
-    def init(self):
-        self.default_precision = 4
-        self.login = ""
-        self.is_commissioning = False
-        self.synchrotron_name = self.get_property("synchrotron_name")
-        self.endstation_name = self.get_property("endstation_name").lower()
-        self.suffix = self["file_info"].get_property("file_suffix")
-        self.base_directory = self["file_info"].get_property("base_directory")
-        self.base_process_directory = self["file_info"].get_property(
-            "processed_data_base_directory"
-        )
-
-        self.raw_data_folder_name = self["file_info"].get_property(
-            "raw_data_folder_name"
-        )
-
-        self.processed_data_folder_name = self["file_info"].get_property(
-            "processed_data_folder_name"
-        )
-
-        try:
-            self.in_house_users = self.get_property("inhouse_users").split(",")
-        except Exception:
-            self.in_house_users = []
-
-        try:
-            domain = socket.getfqdn().split(".")
-            self.email_extension = ".".join((domain[-2], domain[-1]))
-        except (TypeError, IndexError):
-            pass
-
-        archive_base_directory = self["file_info"].get_property(
-            "archive_base_directory"
-        )
-        if archive_base_directory:
-            queue_model_objects.PathTemplate.set_archive_path(
-                archive_base_directory, self["file_info"].get_property("archive_folder")
-            )
-
-        queue_model_objects.PathTemplate.set_path_template_style(self.synchrotron_name)
-        queue_model_objects.PathTemplate.set_data_base_path(self.base_directory)
-
-        self.commissioning_fake_proposal = {
-            "Laboratory": {
-                "address": None,
-                "city": "Lund",
-                "laboratoryId": 312171,
-                "name": "Lund University",
-            },
-            "Person": {
-                "familyName": "commissioning",
-                "givenName": "",
-                "laboratoryId": 312171,
-                "login": "",
-                "personId": 0,
-            },
-            "Proposal": {
-                "code": "MX",
-                "number": time.strftime("%Y"),
-                "proposalId": "0",
-                "timeStamp": time.strftime("%Y%m%d"),
-                "title": "Commissioning Proposal",
-                "type": "MX",
-            },
-            "Session": [
-                {
-                    "is_inhouse": True,
-                    "beamlineName": "BioMAX",
-                    "comments": "Fake session for commissioning",
-                    "endDate": "2027-12-31 23:59:59",
-                    "nbShifts": 100,
-                    "proposalId": "0",
-                    "scheduled": 0,
-                    "sessionId": 0,
-                    "startDate": "2016-01-01 00:00:00",
-                }
-            ],
-        }
-
-    def set_in_commissioning(self, proposal_info):
-        self.proposal_code = proposal_info["Proposal"]["code"]
-        self.proposal_number = proposal_info["Proposal"]["number"]
-        self.is_commissioning = True
-
-    def get_proposal(self):
-        """
-        :returns: The proposal, 'local-user' if no proposal is
-                  available
-        :rtype: str
-        """
-        proposal = "local-user"
-
-        if self.proposal_code and self.proposal_number:
-            if self.proposal_code == "ifx":
-                self.proposal_code = "fx"
-
-            proposal = str(self.proposal_number)
-
-        return proposal
-
-    def get_base_data_directory(self):
-        """
-        Returns the base data directory taking the 'contextual'
-        information into account, such as if the current user
-        is inhouse.
-
-        :returns: The base data path.
-        :rtype: str
-        """
-        if self.session_start_date:
-            start_time = self.session_start_date.split(" ")[0].replace("-", "")
-        else:
-            start_time = time.strftime("%Y%m%d")
-
-        if not self.is_commissioning:
-            # /data/visitors/biomax/prop/visit/
-            # /data/(user-type)/(beamline)/(proposal)/(visit)/raw
-            directory = os.path.join(
-                self.base_directory,
-                "visitors",  # self.get_user_category(self.login),
-                self.beamline_name.lower(),
-                self.get_proposal(),
-                start_time,
-            )
-        else:
-            # /data/staff/biomax/commissioning/date
-            directory = os.path.join(
-                self.base_directory,
-                "staff",
-                self.beamline_name.lower(),
-                "commissioning",
-                time.strftime("%Y%m%d"),
-            )
-
-        logging.getLogger("HWR").info(
-            "[MAX IV Session] Data directory for proposal %s: %s"
-            % (self.get_proposal(), directory)
-        )
-        return directory
-
-    def prepare_directories(self, proposal_info):
-        self.login = proposal_info["Person"]["login"]
-        start_time = proposal_info.get("Session")[0].get("startDate")
-
-        logging.getLogger("HWR").info(
-            "[MAX IV Session] Preparing Data directory for proposal %s" % proposal_info
-        )
-        if start_time:
-            start_date = start_time.split(" ")[0].replace("-", "")
-        else:
-            start_date = time.strftime("%Y%m%d")
-
-        self.set_session_start_date(start_date)
-
-        try:
-            self.storage = storage.Storage(
-                self.get_user_category(self.login), self.endstation_name
-            )
-        except Exception as ex:
-            print(ex)
-            # this creates the path for the data and ensures proper permissions.
-            # e.g. /data/visitors/biomax/<proposal>/<visit>/{raw, process}
-        if self.is_commissioning:
-            group = self.beamline_name.lower()
-        else:
-            group = self.storage.get_proposal_group(self.proposal_number)
-        try:
-            self.storage.create_path(
-                self.proposal_number, group, self.get_session_start_date()
-            )
-
-            proposal_path = "{0}/{1}".format(
-                self.storage.beamline_path, self.proposal_number
-            )
-            logging.getLogger("HWR").info(
-                "[MAX IV Session] SDM Data directory created: %s" % proposal_path
-            )
-        except Exception as ex:
-            msg = "[MAX IV Session] SDM Data directory creation failed. %s" % ex
-            logging.getLogger("HWR").error(msg)
-            raise Exception(msg)
-
-    def is_inhouse(self, user, code=None):
-        """
-        Determines if a given user is considered to be inhouse.
-        :param login: username
-        :type login: str
-        :returns: True if the user is inhouse, otherwise False.
-        :rtype: bool
-        """
-        if user in self.in_house_users:
-            return True
-        else:
-            return False
-
-    def get_user_category(self, user):
-        # 'staff','visitors', 'proprietary'
-        # missing industrial users
-        if self.is_inhouse(user):
-            user_category = "staff"
-        else:
-            user_category = "visitors"
-        return user_category