update docu

nexdatas · Jul 19, 2024 · 65a373d · 65a373d
1 parent 1c9804e
commit 65a373d
Show file tree

Hide file tree

Showing 11 changed files with 46 additions and 29 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: fabf8f614985e2d12cd5cd9639880feb
+config: c58a35c347aab6c80cf903df4cd5477c
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/_modules/index.html b/_modules/index.html
@@ -4,7 +4,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Overview: module code &#8212; Sardana NeXus Recorder 3.28.1 documentation</title>
+    <title>Overview: module code &#8212; Sardana NeXus Recorder 3.29.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../_static/bootstrap-sphinx.css" />
     <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
@@ -37,7 +37,7 @@
         </button>
         <a class="navbar-brand" href="../index.html">
           Sardana NeXus Recorder</a>
-        <span class="navbar-text navbar-version pull-left"><b>3.28</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>3.29</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">

diff --git a/_modules/sardananxsrecorder/nxsrecorder.html b/_modules/sardananxsrecorder/nxsrecorder.html
@@ -4,7 +4,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>sardananxsrecorder.nxsrecorder &#8212; Sardana NeXus Recorder 3.28.1 documentation</title>
+    <title>sardananxsrecorder.nxsrecorder &#8212; Sardana NeXus Recorder 3.29.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../../_static/bootstrap-sphinx.css" />
     <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
@@ -37,7 +37,7 @@
         </button>
         <a class="navbar-brand" href="../../index.html">
           Sardana NeXus Recorder</a>
-        <span class="navbar-text navbar-version pull-left"><b>3.28</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>3.29</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">
@@ -1454,6 +1454,8 @@ <h1>Source code for sardananxsrecorder.nxsrecorder</h1><div class="highlight"><p
         <span class="n">sid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__serial</span>
         <span class="n">fdir</span><span class="p">,</span> <span class="n">fname</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">filename</span><span class="p">)</span>
         <span class="n">snmode</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__getEnvVar</span><span class="p">(</span><span class="s2">&quot;ScanNames&quot;</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
+        <span class="n">nometa</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__getEnvVar</span><span class="p">(</span><span class="s2">&quot;ScanNamesNoMetadata&quot;</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
+        <span class="n">nogrouping</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__getEnvVar</span><span class="p">(</span><span class="s2">&quot;ScanNamesNoGrouping&quot;</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
         <span class="n">appendentry</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__getConfVar</span><span class="p">(</span><span class="s2">&quot;AppendEntry&quot;</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
         <span class="n">pdir</span> <span class="o">=</span> <span class="kc">None</span>
         <span class="k">if</span> <span class="n">snmode</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
@@ -1512,22 +1514,28 @@ <h1>Source code for sardananxsrecorder.nxsrecorder</h1><div class="highlight"><p
             <span class="k">if</span> <span class="n">fdir</span> <span class="ow">in</span> <span class="n">sm</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
                 <span class="n">cgrp</span> <span class="o">=</span> <span class="n">sm</span><span class="p">[</span><span class="n">fdir</span><span class="p">]</span>
                 <span class="k">if</span> <span class="n">cgrp</span> <span class="o">!=</span> <span class="n">scanname</span><span class="p">:</span>
-                    <span class="n">commands</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">&quot;__command__ stop&quot;</span><span class="p">)</span>
-                    <span class="n">commands</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%s</span><span class="s2">:</span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">cgrp</span><span class="p">,</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()))</span>
-                    <span class="n">commands</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">&quot;__command__ start </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="n">scanname</span><span class="p">)</span>
+                    <span class="k">if</span> <span class="ow">not</span> <span class="n">nogrouping</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">nometa</span><span class="p">:</span>
+                        <span class="n">commands</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">&quot;__command__ stop&quot;</span><span class="p">)</span>
+                        <span class="n">commands</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%s</span><span class="s2">:</span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">cgrp</span><span class="p">,</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()))</span>
+                        <span class="n">commands</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">&quot;__command__ start </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="n">scanname</span><span class="p">)</span>
             <span class="k">else</span><span class="p">:</span>
-                <span class="n">commands</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">&quot;__command__ start </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="n">scanname</span><span class="p">)</span>
-            <span class="n">commands</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">sname</span><span class="p">)</span>
-            <span class="n">commands</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">&quot;__command__ stop&quot;</span><span class="p">)</span>
-            <span class="n">commands</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%s</span><span class="s2">:</span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">scanname</span><span class="p">,</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()))</span>
-            <span class="c1"># commands.append(&quot;__command__ start %s&quot; % scanname)</span>
+                <span class="k">if</span> <span class="ow">not</span> <span class="n">nogrouping</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">nometa</span><span class="p">:</span>
+                    <span class="n">commands</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">&quot;__command__ start </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="n">scanname</span><span class="p">)</span>
+            <span class="k">if</span> <span class="ow">not</span> <span class="n">nometa</span><span class="p">:</span>
+                <span class="n">commands</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">sname</span><span class="p">)</span>
+            <span class="k">if</span> <span class="ow">not</span> <span class="n">nogrouping</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">nometa</span><span class="p">:</span>
+                <span class="n">commands</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">&quot;__command__ stop&quot;</span><span class="p">)</span>
+            <span class="k">if</span> <span class="ow">not</span> <span class="n">nogrouping</span><span class="p">:</span>
+                <span class="n">commands</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%s</span><span class="s2">:</span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">scanname</span><span class="p">,</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()))</span>
             <span class="n">sname</span> <span class="o">=</span> <span class="s2">&quot;</span><span class="se">\n</span><span class="s2">&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">commands</span><span class="p">)</span>
 
-            <span class="n">sm</span><span class="p">[</span><span class="n">fdir</span><span class="p">]</span> <span class="o">=</span> <span class="n">scanname</span>
+            <span class="k">if</span> <span class="ow">not</span> <span class="n">nogrouping</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">nometa</span><span class="p">:</span>
+                <span class="n">sm</span><span class="p">[</span><span class="n">fdir</span><span class="p">]</span> <span class="o">=</span> <span class="n">scanname</span>
             <span class="bp">self</span><span class="o">.</span><span class="n">__env</span><span class="p">[</span><span class="s1">&#39;SciCatMeasurements&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">sm</span>
 
-        <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">dslfile</span><span class="p">,</span> <span class="s2">&quot;a+&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">fl</span><span class="p">:</span>
-            <span class="n">fl</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">&quot;</span><span class="se">\n</span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="n">sname</span><span class="p">)</span>
+        <span class="k">if</span> <span class="n">sname</span><span class="p">:</span>
+            <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">dslfile</span><span class="p">,</span> <span class="s2">&quot;a+&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">fl</span><span class="p">:</span>
+                <span class="n">fl</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">&quot;</span><span class="se">\n</span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="n">sname</span><span class="p">)</span>
 
     <span class="k">def</span> <span class="nf">__createMeasurementFile</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot; create measurement file &quot;&quot;&quot;</span>

diff --git a/_static/documentation_options.js b/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '3.28.1',
+    VERSION: '3.29.0',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/genindex.html b/genindex.html
@@ -4,7 +4,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Index &#8212; Sardana NeXus Recorder 3.28.1 documentation</title>
+    <title>Index &#8212; Sardana NeXus Recorder 3.29.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/bootstrap-sphinx.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
@@ -37,7 +37,7 @@
         </button>
         <a class="navbar-brand" href="index.html">
           Sardana NeXus Recorder</a>
-        <span class="navbar-text navbar-version pull-left"><b>3.28</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>3.29</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">

diff --git a/index.html b/index.html
@@ -5,7 +5,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Welcome to sardananxsrecorder’s documentation! &#8212; Sardana NeXus Recorder 3.28.1 documentation</title>
+    <title>Welcome to sardananxsrecorder’s documentation! &#8212; Sardana NeXus Recorder 3.29.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/bootstrap-sphinx.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
@@ -39,7 +39,7 @@
         </button>
         <a class="navbar-brand" href="#">
           Sardana NeXus Recorder</a>
-        <span class="navbar-text navbar-version pull-left"><b>3.28</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>3.29</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">
@@ -287,6 +287,15 @@ <h2>Sardana Variables<a class="headerlink" href="#sardana-variables" title="Perm
 <li><p><strong>NeXusWriterProperties</strong> <em>(dict)</em> - a dictionary of TangoDataWriter (NXSDataWriter) properties (starting with a small letter)</p></li>
 <li><p><strong>NeXusMeshScanID</strong> <em>(int)</em> - ScanID used for composed scans e.g. mesh scan combined from many linear scans</p></li>
 <li><p><strong>NeXusWriterModes</strong> <em>(list)</em> - a list of strategy modes e.g. <code class="docutils literal notranslate"><span class="pre">NOINIT</span></code>, <code class="docutils literal notranslate"><span class="pre">NOSTEP</span></code>, <code class="docutils literal notranslate"><span class="pre">NOFINAL</span></code>, <code class="docutils literal notranslate"><span class="pre">MESH</span></code>, <code class="docutils literal notranslate"><span class="pre">VDS</span></code>  separated by commas</p></li>
+<li><p><strong>ScanNames</strong> <em>(bool)</em> - special mode of using ScanName directories i.e.</p>
+<ul>
+<li><p><code class="docutils literal notranslate"><span class="pre">True</span></code>: the master file in the ScanName directory,</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">False</span></code>: the master file in the grouping ScanName directory (e.g. without ScanID),</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">None</span></code> (or undefined):  standard mode where the master files are outside the ScanName directory</p></li>
+</ul>
+</li>
+<li><p><strong>ScanNamesNoGrouping</strong> <em>(bool)</em> - do not perform grouping when <code class="docutils literal notranslate"><span class="pre">ScanNames</span></code> is <code class="docutils literal notranslate"><span class="pre">False</span></code></p></li>
+<li><p><strong>ScanNamesNoMetadata</strong> <em>(bool)</em> - do not perform master file metadata ingestion when <code class="docutils literal notranslate"><span class="pre">ScanNames</span></code> is <code class="docutils literal notranslate"><span class="pre">False</span></code></p></li>
 </ul>
 <p>Contents:</p>
 <div class="toctree-wrapper compound">

diff --git a/objects.inv b/objects.inv
@@ -1,6 +1,6 @@
 # Sphinx inventory version 2
 # Project: Sardana NeXus Recorder
-# Version: 3.28
+# Version: 3.29
 # The remainder of this file is compressed using zlib.
 xڽ�MN�0��9� �&��n�JH�*��]5����"{,���z��$�"US�P�.�y�yV�^�E����<T��85�%��vQ���I�_@�HFs+�˙��سC��Q�?�K��*v��ĥ��Ɛ��p���	�����G���7ȡ�Gf�V��Ĉ񬣌�FS�7V��>���ƨhCVYI[,�W�!�������̾e҉V�S<����}��hf�!���ٳ�y
 �U����>=)i�^���y�$��Ӈ{�����:T(^pCY ����$���"����X

diff --git a/py-modindex.html b/py-modindex.html
@@ -4,7 +4,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Python Module Index &#8212; Sardana NeXus Recorder 3.28.1 documentation</title>
+    <title>Python Module Index &#8212; Sardana NeXus Recorder 3.29.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/bootstrap-sphinx.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
@@ -40,7 +40,7 @@
         </button>
         <a class="navbar-brand" href="index.html">
           Sardana NeXus Recorder</a>
-        <span class="navbar-text navbar-version pull-left"><b>3.28</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>3.29</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">

diff --git a/sardananxsrecorder.html b/sardananxsrecorder.html
@@ -5,7 +5,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>sardananxsrecorder package &#8212; Sardana NeXus Recorder 3.28.1 documentation</title>
+    <title>sardananxsrecorder package &#8212; Sardana NeXus Recorder 3.29.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/bootstrap-sphinx.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
@@ -39,7 +39,7 @@
         </button>
         <a class="navbar-brand" href="index.html">
           Sardana NeXus Recorder</a>
-        <span class="navbar-text navbar-version pull-left"><b>3.28</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>3.29</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">