sardana-nxsrecorder 3.22.0__tar.gz → 3.24.0__tar.gz

{sardana-nxsrecorder-3.22.0 → sardana-nxsrecorder-3.24.0}/ChangeLog

@@ -1,3 +1,11 @@
+2024-06-06 Jan Kotanski <jankotan@gmail.com>
+	* set TangoDataWriter properties from NeXusWriterProperties variable (#121)
+	* tagged as 3.24.0
+
+2024-06-04 Jan Kotanski <jankotan@gmail.com>
+	* skip acquisition for the modes listed in NeXusSkipAcquisitionModes variable (#117)
+	* tagged as 3.23.0
+
 2024-06-03 Jan Kotanski <jankotan@gmail.com>
 	* improve support for ScanFile formating wih _%05d and _{ScanID:05d} (#114)
 	* tagged as 3.22.0

{sardana-nxsrecorder-3.22.0/sardana_nxsrecorder.egg-info → sardana-nxsrecorder-3.24.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sardana-nxsrecorder
-Version: 3.22.0
+Version: 3.24.0
 Summary: NeXus Sardana Scan Recorder
 Home-page: https://github.com/nexdatas/sardana-nxs-filerecorder/
 Author: Jan Kotanski
@@ -234,6 +234,8 @@ The NeXus file recorder uses the following sardana environment variables
 
 * **ActiveMntGrp** *(str)* - active measurement group
 * **ScanID** *(int)* - the last scan identifier number, default: ``-1``
+* **ScanDir** *(str)* - the scan directory
+* **ScanFile** *(list)* - a list of scan files
 * **NeXusSelectorDevice** *(str)* - NXSRecSelector tango device if more installed, otherwise first one found
 
 * **NXSAppendSciCatDataset** *(bool)* - append scan name to scicat dataset list file, default: ``False``
@@ -247,4 +249,6 @@ The NeXus file recorder uses the following sardana environment variables
 * **MetadataScript** *(str)* - a python module file name containing ``main()``  which provides a dictionary with user metadata stored in the INIT mode, default: ``""``
 * **ScicatMeasurements** *(dict)* - a dictionary of  measurement names indexed by ``ScanDir`` and  used by ``scingestor``, default: ``{}``
 * **CreateMeasurementFile** *(bool)* - create a measurement file with its filename releated to ``ScicatMeasurements`` or ``ScanFile``, default: ``False``
+* **NeXusSkipAcquisitionModes** *(list)* - a list of strategy modes for which acquisition is skip
+* **NeXusWriterProperties** *(dict)* - a dictionary of TangoDataWriter (NXSDataWriter) properties (starting with a small letter)
   

{sardana-nxsrecorder-3.22.0 → sardana-nxsrecorder-3.24.0}/README.rst

@@ -209,6 +209,8 @@ The NeXus file recorder uses the following sardana environment variables
 
 * **ActiveMntGrp** *(str)* - active measurement group
 * **ScanID** *(int)* - the last scan identifier number, default: ``-1``
+* **ScanDir** *(str)* - the scan directory
+* **ScanFile** *(list)* - a list of scan files
 * **NeXusSelectorDevice** *(str)* - NXSRecSelector tango device if more installed, otherwise first one found
 
 * **NXSAppendSciCatDataset** *(bool)* - append scan name to scicat dataset list file, default: ``False``
@@ -222,4 +224,6 @@ The NeXus file recorder uses the following sardana environment variables
 * **MetadataScript** *(str)* - a python module file name containing ``main()``  which provides a dictionary with user metadata stored in the INIT mode, default: ``""``
 * **ScicatMeasurements** *(dict)* - a dictionary of  measurement names indexed by ``ScanDir`` and  used by ``scingestor``, default: ``{}``
 * **CreateMeasurementFile** *(bool)* - create a measurement file with its filename releated to ``ScicatMeasurements`` or ``ScanFile``, default: ``False``
+* **NeXusSkipAcquisitionModes** *(list)* - a list of strategy modes for which acquisition is skip
+* **NeXusWriterProperties** *(dict)* - a dictionary of TangoDataWriter (NXSDataWriter) properties (starting with a small letter)
   

{sardana-nxsrecorder-3.22.0 → sardana-nxsrecorder-3.24.0}/man/sardananxsrecorder.1

@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
-.TH "SARDANANXSRECORDER" "1" "Jun 03, 2024" "3.22" "Sardana NeXus Recorder"
+.TH "SARDANANXSRECORDER" "1" "Jun 04, 2024" "3.23" "Sardana NeXus Recorder"
 .SH NAME
 sardananxsrecorder \- sardananxsrecorder Documentation
 .sp
@@ -326,6 +326,10 @@ The NeXus file recorder uses the following sardana environment variables
 .IP \(bu 2
 \fBScanID\fP \fI(int)\fP \- the last scan identifier number, default: \fB\-1\fP
 .IP \(bu 2
+\fBScanDir\fP \fI(str)\fP \- the scan directory
+.IP \(bu 2
+\fBScanFile\fP \fI(list)\fP \- a list of scan files
+.IP \(bu 2
 \fBNeXusSelectorDevice\fP \fI(str)\fP \- NXSRecSelector tango device if more installed, otherwise first one found
 .IP \(bu 2
 \fBNXSAppendSciCatDataset\fP \fI(bool)\fP \- append scan name to scicat dataset list file, default: \fBFalse\fP
@@ -349,6 +353,8 @@ The NeXus file recorder uses the following sardana environment variables
 \fBScicatMeasurements\fP \fI(dict)\fP \- a dictionary of  measurement names indexed by \fBScanDir\fP and  used by \fBscingestor\fP, default: \fB{}\fP
 .IP \(bu 2
 \fBCreateMeasurementFile\fP \fI(bool)\fP \- create a measurement file with its filename releated to \fBScicatMeasurements\fP or \fBScanFile\fP, default: \fBFalse\fP
+.IP \(bu 2
+\fBNeXusSkipAcquisitionModes\fP \fI(list)\fP \- a list of strategy modes for which acquisition is skip
 .UNINDENT
 .sp
 Contents:

{sardana-nxsrecorder-3.22.0 → sardana-nxsrecorder-3.24.0/sardana_nxsrecorder.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sardana-nxsrecorder
-Version: 3.22.0
+Version: 3.24.0
 Summary: NeXus Sardana Scan Recorder
 Home-page: https://github.com/nexdatas/sardana-nxs-filerecorder/
 Author: Jan Kotanski
@@ -234,6 +234,8 @@ The NeXus file recorder uses the following sardana environment variables
 
 * **ActiveMntGrp** *(str)* - active measurement group
 * **ScanID** *(int)* - the last scan identifier number, default: ``-1``
+* **ScanDir** *(str)* - the scan directory
+* **ScanFile** *(list)* - a list of scan files
 * **NeXusSelectorDevice** *(str)* - NXSRecSelector tango device if more installed, otherwise first one found
 
 * **NXSAppendSciCatDataset** *(bool)* - append scan name to scicat dataset list file, default: ``False``
@@ -247,4 +249,6 @@ The NeXus file recorder uses the following sardana environment variables
 * **MetadataScript** *(str)* - a python module file name containing ``main()``  which provides a dictionary with user metadata stored in the INIT mode, default: ``""``
 * **ScicatMeasurements** *(dict)* - a dictionary of  measurement names indexed by ``ScanDir`` and  used by ``scingestor``, default: ``{}``
 * **CreateMeasurementFile** *(bool)* - create a measurement file with its filename releated to ``ScicatMeasurements`` or ``ScanFile``, default: ``False``
+* **NeXusSkipAcquisitionModes** *(list)* - a list of strategy modes for which acquisition is skip
+* **NeXusWriterProperties** *(dict)* - a dictionary of TangoDataWriter (NXSDataWriter) properties (starting with a small letter)
   

{sardana-nxsrecorder-3.22.0 → sardana-nxsrecorder-3.24.0}/sardananxsrecorder/__init__.py

@@ -20,4 +20,4 @@
 """ Sardana Scan Recorders """
 
 #: package version
-__version__ = "3.22.0"
+__version__ = "3.24.0"

{sardana-nxsrecorder-3.22.0 → sardana-nxsrecorder-3.24.0}/sardananxsrecorder/nxsrecorder.py

@@ -155,6 +155,9 @@ class NXS_FileRecorder(BaseFileRecorder):
         #: (:obj:`dict` <:obj:`str` , :obj:`str`>) NeXus configuration
         self.__conf = {}
 
+        #: (:obj:`list` <:obj:`str`>) skip Acquisition Modes
+        self.skipAcquisitionModes = []
+
         #: (:obj:`dict` <:obj:`str` , `any`>) User data
         self.__udata = None
 
@@ -540,6 +543,18 @@ class NXS_FileRecorder(BaseFileRecorder):
             if self.__nexuswriter_device is None:
                 from nxswriter import TangoDataWriter
                 self.__nexuswriter_device = TangoDataWriter.TangoDataWriter()
+                try:
+                    properties = dict(
+                        self.__getEnvVar("NeXusWriterProperties", {}))
+                except Exception as e:
+                    self.warning(
+                        "Cannot load NeXusWriterProperties %s" % (str(e)))
+                    self.__macro().warning(
+                        "Cannot load NeXusWriterProperties %s" % (str(e)))
+                    properties = {}
+                for ky, vl in properties.items():
+                    if hasattr(self.__nexuswriter_device, ky):
+                        setattr(self.__nexuswriter_device, ky, vl)
 
     def __get_alias(self, name):
         """ provides a device alias
@@ -1020,6 +1035,10 @@ class NXS_FileRecorder(BaseFileRecorder):
             # self.debug('START_DATA: %s' % str(envRec))
 
             self.__nexuswriter_device.jsonrecord = rec
+            self.skipAcquisitionModes = self.__skipAcquisitionModes()
+            if "INIT" in self.skipAcquisitionModes:
+                self.__nexuswriter_device.skipAcquisition = True
+
             self.__command(self.__nexuswriter_device, "openEntry")
         except Exception:
             self.__removeDynamicComponent()
@@ -1106,6 +1125,8 @@ class NXS_FileRecorder(BaseFileRecorder):
             rec = json.dumps(
                 envrecord, cls=NXS_FileRecorder.numpyEncoder)
             self.__nexuswriter_device.jsonrecord = rec
+            if "STEP" in self.skipAcquisitionModes:
+                self.__nexuswriter_device.skipAcquisition = True
 
             # self.debug('DATA: {"data":%s}' % json.dumps(
             #     record.data,
@@ -1174,6 +1195,8 @@ class NXS_FileRecorder(BaseFileRecorder):
             rec = json.dumps(
                 envrecord, cls=NXS_FileRecorder.numpyEncoder)
             self.__nexuswriter_device.jsonrecord = rec
+            if "FINAL" in self.skipAcquisitionModes:
+                self.__nexuswriter_device.skipAcquisition = True
             self.__command(self.__nexuswriter_device, "closeEntry")
             self.__command(self.__nexuswriter_device, "closeFile")
         except Exception:
@@ -1220,6 +1243,19 @@ class NXS_FileRecorder(BaseFileRecorder):
         beamtimeid = self.beamtime_id(bmtfpath, bmtfprefix, bmtfext)
         return beamtimeid or "00000000"
 
+    def __skipAcquisitionModes(self):
+        """ find skip acquisition modes
+        """
+        try:
+            skip_acq = self.__macro().getEnv('NeXusSkipAcquisitionModes')
+        except Exception:
+            skip_acq = []
+        if isinstance(skip_acq, str):
+            skip_acq = re.split(r"[-;,.\s]\s*", skip_acq)
+        if skip_acq:
+            self.debug('Skip Acquisition Modes: %s' % str(skip_acq))
+        return skip_acq
+
     def __rawfilename(self, serial):
         """ find scan name
         """
@@ -1309,6 +1345,8 @@ class NXS_FileRecorder(BaseFileRecorder):
             sid = self.__vars["vars"]["scan_id"]
             sname = "%s::/%s_%05i;%s_%05i" % (
                 scanname, entryname, sid, scanname, sid)
+        if "INIT" in self.skipAcquisitionModes:
+            sname = "%s:%s" % (sname, time.time())
 
         # auto grouping
         grouping = bool(self.__getEnvVar('SciCatAutoGrouping', False))
@@ -1370,7 +1408,6 @@ class NXS_FileRecorder(BaseFileRecorder):
                "{ScanID" not in self.__raw_filename:
                 sname = sname + ("_%05i" % sid)
                 entryname = entryname + ("_%05i" % sid)
-
         mntname = scanname
         if fdir in sm.keys() and sm[fdir]:
             mntname = sm[fdir]