sardana-nxsrecorder 3.19.0__tar.gz → 3.20.0__tar.gz

{sardana-nxsrecorder-3.19.0 → sardana-nxsrecorder-3.20.0}/ChangeLog

@@ -1,3 +1,7 @@
+2024-05-22 Jan Kotanski <jankotan@gmail.com>
+	* add support for creating measurement files (#105)
+	* tagged as 3.20.0
+
 2024-05-13 Jan Kotanski <jankotan@gmail.com>
 	* send count_time beamtime_id and npoints to writer (#103)
 	* tagged as 3.19.0

{sardana-nxsrecorder-3.19.0/sardana_nxsrecorder.egg-info → sardana-nxsrecorder-3.20.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sardana-nxsrecorder
-Version: 3.19.0
+Version: 3.20.0
 Summary: NeXus Sardana Scan Recorder
 Home-page: https://github.com/nexdatas/sardana-nxs-filerecorder/
 Author: Jan Kotanski
@@ -245,3 +245,6 @@ The NeXus file recorder uses the following sardana environment variables
 * **SciCatDatasetListFileLocal** *(bool)* - add the hostname to the scicat dataset list file extension, default: ``False``
 * **SciCatAutoGrouping** *(bool)* - group all scans with the measurement name set to the base scan filename, default: ``False``
 * **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``
+  

{sardana-nxsrecorder-3.19.0 → sardana-nxsrecorder-3.20.0}/README.rst

@@ -220,3 +220,6 @@ The NeXus file recorder uses the following sardana environment variables
 * **SciCatDatasetListFileLocal** *(bool)* - add the hostname to the scicat dataset list file extension, default: ``False``
 * **SciCatAutoGrouping** *(bool)* - group all scans with the measurement name set to the base scan filename, default: ``False``
 * **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``
+  

{sardana-nxsrecorder-3.19.0 → sardana-nxsrecorder-3.20.0/sardana_nxsrecorder.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sardana-nxsrecorder
-Version: 3.19.0
+Version: 3.20.0
 Summary: NeXus Sardana Scan Recorder
 Home-page: https://github.com/nexdatas/sardana-nxs-filerecorder/
 Author: Jan Kotanski
@@ -245,3 +245,6 @@ The NeXus file recorder uses the following sardana environment variables
 * **SciCatDatasetListFileLocal** *(bool)* - add the hostname to the scicat dataset list file extension, default: ``False``
 * **SciCatAutoGrouping** *(bool)* - group all scans with the measurement name set to the base scan filename, default: ``False``
 * **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``
+  

{sardana-nxsrecorder-3.19.0 → sardana-nxsrecorder-3.20.0}/sardananxsrecorder/__init__.py

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

{sardana-nxsrecorder-3.19.0 → sardana-nxsrecorder-3.20.0}/sardananxsrecorder/nxsrecorder.py

@@ -35,6 +35,15 @@ try:
 except Exception:
     import PyTango as tango
 
+try:
+    NXSWRITER = True
+    try:
+        from nxstools import h5cppwriter as h5writer
+    except Exception:
+        from nxstools import h5pywriter as h5writer
+except Exception:
+    NXSWRITER = False
+
 
 from sardana.macroserver.scan.recorder.storage import BaseFileRecorder
 
@@ -1157,6 +1166,9 @@ class NXS_FileRecorder(BaseFileRecorder):
             vl = self.__getEnvVar("NXSAppendSciCatDataset", None)
             if vl:
                 self.__appendSciCatDataset(vl)
+            cmf = self.__getEnvVar("CreateMeasurementFile", False)
+            if cmf and NXSWRITER:
+                self.__createMeasurementFile()
 
     def beamtime_id(self, bmtfpath, bmtfprefix, bmtfext):
         """ code for beamtimeid  datasource
@@ -1227,6 +1239,7 @@ class NXS_FileRecorder(BaseFileRecorder):
 
         # auto grouping
         grouping = bool(self.__getEnvVar('SciCatAutoGrouping', False))
+
         if grouping:
             commands = []
             try:
@@ -1254,6 +1267,48 @@ class NXS_FileRecorder(BaseFileRecorder):
         with open(dslfile, "a+") as fl:
             fl.write("\n%s" % sname)
 
+    def __createMeasurementFile(self):
+        """ create measurement file """
+
+        fdir, fname = os.path.split(self.filename)
+        _, bfname = os.path.split(self.__base_filename)
+        sname, fext = os.path.splitext(fname)
+        # beamtimeid = self.beamtimeid()
+
+        try:
+            scanname, _ = os.path.splitext(bfname % "")
+        except Exception:
+            scanname, _ = os.path.splitext(bfname)
+
+        try:
+            sm = dict(self.__getEnvVar('SciCatMeasurements', {}))
+        except Exception:
+            sm = {}
+
+        entryname = "scan"
+        appendentry = self.__getConfVar("AppendEntry", False)
+        variables = self.__getConfVar("ConfigVariables", None, True)
+        if isinstance(variables, dict) and "entryname" in variables:
+            entryname = variables["entryname"]
+
+        mntname = scanname
+        if fdir in sm.keys() and sm[fdir]:
+            mntname = sm[fdir]
+        if not appendentry or mntname != scanname:
+            mntfile = os.path.join(fdir, mntname + fext)
+
+            if not os.path.exists(mntfile):
+                fl = h5writer.create_file(mntfile)
+                self.info("Measurement file '%s' created " % mntname)
+            else:
+                fl = h5writer.open_file(mntfile, readonly=False)
+            rt = fl.root()
+            if sname not in rt.names():
+                h5writer.link("%s:/%s" % (self.filename, entryname), rt, sname)
+                self.debug("Link  '%s' in '%s' created " % (sname, mntname))
+            rt.close()
+            fl.close()
+
     def _addCustomData(self, value, name, group="data", remove=False,
                        **kwargs):
         """ adds custom data to configuration variables, i.e. from macros