update docu

nexdatas · Nov 6, 2024 · 30ba29e · 30ba29e
1 parent 750b291
commit 30ba29e
Show file tree

Hide file tree

Showing 17 changed files with 1,116 additions and 1,072 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: 5612c70f8794646354c77397adf035bf
+config: 9dc2501bce5111257bf46e662605b035
 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; NXSTools 4.16.1 documentation</title>
+    <title>Overview: module code &#8212; NXSTools 4.17.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">
           NXSTools</a>
-        <span class="navbar-text navbar-version pull-left"><b>4.16</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>4.17</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">

diff --git a/_modules/nxstools/nxsfileinfo.html b/_modules/nxstools/nxsfileinfo.html
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: '4.16.1',
+    VERSION: '4.17.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; NXSTools 4.16.1 documentation</title>
+    <title>Index &#8212; NXSTools 4.17.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">
           NXSTools</a>
-        <span class="navbar-text navbar-version pull-left"><b>4.16</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>4.17</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">
@@ -2450,6 +2450,8 @@ <h2 id="S">S</h2>
       <li><a href="nxstools.html#nxstools.nxsconfig.ConfigServer.showCmd">showCmd() (nxstools.nxsconfig.ConfigServer method)</a>
 </li>
       <li><a href="nxstools.html#nxstools.filewriter.FTDataFilter.shuffle">shuffle (nxstools.filewriter.FTDataFilter property)</a>
+</li>
+      <li><a href="nxstools.html#nxstools.nxsfileinfo.GroupMetadata.singlelisttype">singlelisttype (nxstools.nxsfileinfo.GroupMetadata attribute)</a>
 </li>
       <li><a href="nxstools.html#nxstools.filewriter.FTField.size">size (nxstools.filewriter.FTField property)</a>
 

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 nxstools’s documentation! &#8212; NXSTools 4.16.1 documentation</title>
+    <title>Welcome to nxstools&#39;s documentation! &#8212; NXSTools 4.17.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="#">
           NXSTools</a>
-        <span class="navbar-text navbar-version pull-left"><b>4.16</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>4.17</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">
@@ -155,7 +155,7 @@
   <ul class="dropdown-menu localtoc"
       role="menu"
       aria-labelledby="dLabelLocalToc"><ul>
-<li><a class="reference internal" href="#">Welcome to nxstools’s documentation!</a><ul>
+<li><a class="reference internal" href="#">Welcome to nxstools's documentation!</a><ul>
 <li><a class="reference internal" href="#introduction">Introduction</a></li>
 <li><a class="reference internal" href="#installation">Installation</a><ul>
 <li><a class="reference internal" href="#from-sources">From sources</a></li>
@@ -205,7 +205,7 @@
     <div class="body col-md-12 content" role="main">
 
   <section id="welcome-to-nxstools-s-documentation">
-<h1>Welcome to nxstools’s documentation!<a class="headerlink" href="#welcome-to-nxstools-s-documentation" title="Permalink to this heading">¶</a></h1>
+<h1>Welcome to nxstools's documentation!<a class="headerlink" href="#welcome-to-nxstools-s-documentation" title="Permalink to this heading">¶</a></h1>
 <p><a class="reference external" href="https://github.com/nexdatas/nxstools/actions"><img alt="" src="https://github.com/nexdatas/nxstools/actions/workflows/tests.yml/badge.svg" /></a>
 <a class="reference external" href="https://nexdatas.github.io/nxstools/index.html"><img alt="" src="https://img.shields.io/badge/Documentation-webpages-ADD8E6.svg" /></a>
 <a class="reference external" href="https://pypi.python.org/pypi/nxstools"><img alt="" src="https://img.shields.io/pypi/v/nxstools.svg" /></a>

diff --git a/nxscollect.html b/nxscollect.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>nxcollect &#8212; NXSTools 4.16.1 documentation</title>
+    <title>nxcollect &#8212; NXSTools 4.17.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>
@@ -17,7 +17,7 @@
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="nxsconfig" href="nxsconfig.html" />
-    <link rel="prev" title="Welcome to nxstools’s documentation!" href="index.html" />
+    <link rel="prev" title="Welcome to nxstools&#39;s documentation!" href="index.html" />
 <meta charset='utf-8'>
 <meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
 <meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
@@ -40,7 +40,7 @@
         </button>
         <a class="navbar-brand" href="index.html">
           NXSTools</a>
-        <span class="navbar-text navbar-version pull-left"><b>4.16</b></span>
+        <span class="navbar-text navbar-version pull-left"><b>4.17</b></span>
       </div>
 
         <div class="collapse navbar-collapse nav-collapse">
@@ -175,7 +175,7 @@
 
 
   <li>
-    <a href="index.html" title="Previous Chapter: Welcome to nxstools’s documentation!"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">&laquo; Welcome to nx...</span>
+    <a href="index.html" title="Previous Chapter: Welcome to nxstools's documentation!"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">&laquo; Welcome to nx...</span>
     </a>
   </li>
   <li>
@@ -235,7 +235,7 @@ <h2>Synopsis for nxscollect append<a class="headerlink" href="#synopsis-for-nxsc
 </dd>
 <dt><kbd><span class="option">-c <var>COMPRESSION</var></span>, <span class="option">--compression <var>COMPRESSION</var></span></kbd></dt>
 <dd><p>deflate compression rate from 0 to 9 (default: 2) or
-&lt;filterid&gt;:opt1,opt2,… e.g. -c 32008:0,2 for
+&lt;filterid&gt;:opt1,opt2,... e.g. -c 32008:0,2 for
 bitshuffle with lz4</p>
 </dd>
 <dt><kbd><span class="option">-p <var>PATH</var></span>, <span class="option">--path <var>PATH</var></span></kbd></dt>
@@ -244,18 +244,18 @@ <h2>Synopsis for nxscollect append<a class="headerlink" href="#synopsis-for-nxsc
 </dd>
 <dt><kbd><span class="option">-i <var>INPUTFILES</var></span>, <span class="option">--input_files <var>INPUTFILES</var></span></kbd></dt>
 <dd><p>input data files defined with a pattern or separated
-by ‘,’ e.g.’scan_%05d.tif:0:100’</p>
+by ',' e.g.'scan_%05d.tif:0:100'</p>
 </dd>
 <dt><kbd><span class="option">--separator <var>SEPARATOR</var></span></kbd></dt>
-<dd><p>input data files separator (default: ‘,’)</p>
+<dd><p>input data files separator (default: ',')</p>
 </dd>
 <dt><kbd><span class="option">--dtype <var>DATATYPE</var></span></kbd></dt>
 <dd><p>datatype of input data - only for raw data, e.g.
-‘uint8’</p>
+'uint8'</p>
 </dd>
 <dt><kbd><span class="option">--shape <var>SHAPE</var></span></kbd></dt>
 <dd><p>shape of input data - only for raw data, e.g.
-‘[4096,2048]’</p>
+'[4096,2048]'</p>
 </dd>
 <dt><kbd><span class="option">-s</span>, <span class="option">--skip_missing</span></kbd></dt>
 <dd><p>skip missing files</p>
@@ -354,99 +354,99 @@ <h2>Synopsis for nxscollect vds<a class="headerlink" href="#synopsis-for-nxscoll
 <dd><p>show this help message and exit</p>
 </dd>
 <dt><kbd><span class="option">-t <var>DTYPE</var></span>, <span class="option">--dtype <var>DTYPE</var></span></kbd></dt>
-<dd><p>datatype of the VDS field, e.g. ‘uint8’</p>
+<dd><p>datatype of the VDS field, e.g. 'uint8'</p>
 </dd>
 <dt><kbd><span class="option">-s <var>SHAPE</var></span>, <span class="option">--shape <var>SHAPE</var></span></kbd></dt>
-<dd><p>shape of the VDS field, e.g. ‘[U,4096,2048]’ or
-U,4096,2048 where U means span along the field’</p>
+<dd><p>shape of the VDS field, e.g. '[U,4096,2048]' or
+U,4096,2048 where U means span along the field'</p>
 </dd>
 <dt><kbd><span class="option">-f <var>FILLVALUE</var></span>, <span class="option">--fill-value <var>FILLVALUE</var></span></kbd></dt>
 <dd><p>fill value for the gaps, default is 0</p>
 </dd>
 <dt><kbd><span class="option">-e <var>TARGETFIELDS</var></span>, <span class="option">--target-fields <var>TARGETFIELDS</var></span></kbd></dt>
 <dd><p>external fields with their NeXus file paths defined
-with a pattern or separated by ‘,’
-e.g.’scan_123/lambda_%05d.nxs://entry/data/<a class="reference external" href="data:0:3">data:0:3</a>’</p>
+with a pattern or separated by ','
+e.g.'scan_123/lambda_%05d.nxs://entry/data/<a class="reference external" href="data:0:3">data:0:3</a>'</p>
 </dd>
 <dt><kbd><span class="option">--separator <var>SEPARATOR</var></span></kbd></dt>
-<dd><p>input data files separator (default: ‘,’)</p>
+<dd><p>input data files separator (default: ',')</p>
 </dd>
 <dt><kbd><span class="option">-p <var>SHAPES</var></span>, <span class="option">--shapes <var>SHAPES</var></span></kbd></dt>
 <dd><p>shapes in the VDS layout hyperslab for the
 corresponding target fields with coordinates sepatated
-by ‘,’ and different fields separated by ‘;’, ‘:’ or
-spaces e.g.’,,;,300,;,600,0’ where an empty coordinate
+by ',' and different fields separated by ';', ':' or
+spaces e.g.',,;,300,;,600,0' where an empty coordinate
 means 0</p>
 </dd>
 <dt><kbd><span class="option">-o <var>OFFSETS</var></span>, <span class="option">--offsets <var>OFFSETS</var></span></kbd></dt>
 <dd><p>offsets in the VDS layout hyperslab for the
 corresponding target fields with coordinates sepatated
-by ‘,’ and different fields separated by ‘;’, ‘:’ or
-spaces e.g.’,,;,300,;,600,0’ where an empty coordinate
+by ',' and different fields separated by ';', ':' or
+spaces e.g.',,;,300,;,600,0' where an empty coordinate
 means 0</p>
 </dd>
 <dt><kbd><span class="option">-b <var>BLOCKS</var></span>, <span class="option">--blocks <var>BLOCKS</var></span></kbd></dt>
 <dd><p>block sizes in the VDS layout hyperslab for the
 corresponding target fields with coordinates sepatated
-by ‘,’ and different fields separated by ‘;’, ‘:’ or
-spaces e.g. ‘,256,512;,256,512;,256,512’ where an
+by ',' and different fields separated by ';', ':' or
+spaces e.g. ',256,512;,256,512;,256,512' where an
 empty coordinate means 1</p>
 </dd>
 <dt><kbd><span class="option">-c <var>COUNTS</var></span>, <span class="option">--counts <var>COUNTS</var></span></kbd></dt>
 <dd><p>count numbers in the VDS layout hyperslabfor the
 corresponding target fields with coordinates sepatated
-by ‘,’ and different fields separated by ‘;’, ‘:’ or
-spaces e.g. ‘,1,1;,1,1;,1,1’ where an empty coordinate
+by ',' and different fields separated by ';', ':' or
+spaces e.g. ',1,1;,1,1;,1,1' where an empty coordinate
 means span along the layout</p>
 </dd>
 <dt><kbd><span class="option">-d <var>STRIDES</var></span>, <span class="option">--strides <var>STRIDES</var></span></kbd></dt>
 <dd><p>stride sizes in the VDS layout hyperslabfor the
 corresponding target fields with coordinates sepatated
-by ‘,’ and different fields separated by ‘;’, ‘:’ or
-spaces e.g. ‘,,;,,;,,’ where an empty coordinate means
+by ',' and different fields separated by ';', ':' or
+spaces e.g. ',,;,,;,,' where an empty coordinate means
 1</p>
 </dd>
 <dt><kbd><span class="option">-l <var>SLICES</var></span>, <span class="option">--slices <var>SLICES</var></span></kbd></dt>
 <dd><p>mapping slices in the VDS layoutfor the corresponding
-target fields with coordinates sepatated by ‘,’ and
-different fields separated by ‘;’ or spaces e.g.
-‘:,0:50,: :,50:100,:’ where U means span along the
+target fields with coordinates sepatated by ',' and
+different fields separated by ';' or spaces e.g.
+':,0:50,: :,50:100,:' where U means span along the
 layout</p>
 </dd>
 <dt><kbd><span class="option">-P <var>TARGETSHAPES</var></span>, <span class="option">--target-shapes <var>TARGETSHAPES</var></span></kbd></dt>
-<dd><p>field shapes with coordinates sepatated by ‘,’ and
-different fields separated by ‘;’, ‘:’ or spaces
-e.g.’,,;,300,;,600,0’</p>
+<dd><p>field shapes with coordinates sepatated by ',' and
+different fields separated by ';', ':' or spaces
+e.g.',,;,300,;,600,0'</p>
 </dd>
 <dt><kbd><span class="option">-O <var>TARGETOFFSETS</var></span>, <span class="option">--target-offsets <var>TARGETOFFSETS</var></span></kbd></dt>
 <dd><p>offsets in the view hyperslab of target fieldswith
-coordinates sepatated by ‘,’ and different fields
-separated by ‘;’, ‘:’ or spaces e.g.’,,;,300,;,600,0’
+coordinates sepatated by ',' and different fields
+separated by ';', ':' or spaces e.g.',,;,300,;,600,0'
 where an empty coordinate means 0</p>
 </dd>
 <dt><kbd><span class="option">-B <var>TARGETBLOCKS</var></span>, <span class="option">--target-blocks <var>TARGETBLOCKS</var></span></kbd></dt>
 <dd><p>block sizes in the view hyperslab of target fields
-with coordinates sepatated by ‘,’ and different fields
-separated by ‘;’, ‘:’ or spaces e.g.
-‘,256,512;,256,512;,256,512’ where an empty coordinate
+with coordinates sepatated by ',' and different fields
+separated by ';', ':' or spaces e.g.
+',256,512;,256,512;,256,512' where an empty coordinate
 means 1</p>
 </dd>
 <dt><kbd><span class="option">-C <var>TARGETCOUNTS</var></span>, <span class="option">--target-counts <var>TARGETCOUNTS</var></span></kbd></dt>
 <dd><p>count numbers in the view hyperslab of target fields
-with coordinates sepatated by ‘,’ and different fields
-separated by ‘;’, ‘:’ or spaces e.g. ‘,1,1;,1,1;,1,1’
+with coordinates sepatated by ',' and different fields
+separated by ';', ':' or spaces e.g. ',1,1;,1,1;,1,1'
 where an empty coordinate means span along the layout</p>
 </dd>
 <dt><kbd><span class="option">-D <var>TARGETSTRIDES</var></span>, <span class="option">--target-strides <var>TARGETSTRIDES</var></span></kbd></dt>
 <dd><p>stride sizes numbers in the view hyperslab of target
-fields with coordinates sepatated by ‘,’ and different
-fields separated by ‘;’, ‘:’ or spaces e.g. ‘,,;,,;,,’
+fields with coordinates sepatated by ',' and different
+fields separated by ';', ':' or spaces e.g. ',,;,,;,,'
 where an empty coordinate means 1</p>
 </dd>
 <dt><kbd><span class="option">-L <var>TARGETSLICES</var></span>, <span class="option">--target-slices <var>TARGETSLICES</var></span></kbd></dt>
 <dd><p>view slices of target fields with coordinates
-sepatated by ‘,’ and different fields separated by ‘;’
-or spaces e.g. ‘:,0:50,: :,0:50,:’ where U means span
+sepatated by ',' and different fields separated by ';'
+or spaces e.g. ':,0:50,: :,0:50,:' where U means span
 along the layout</p>
 </dd>
 <dt><kbd><span class="option">-r</span>, <span class="option">--replace-nexus-file</span></kbd></dt>