From e743c098b50983e83f278a892ae2d23c86ace0dc Mon Sep 17 00:00:00 2001 From: Jan Kotanski Date: Thu, 7 Nov 2024 10:51:09 +0100 Subject: [PATCH] update README --- README.rst | 25 ++---------- man/sardananxsrecorder.1 | 85 ++++++++++++---------------------------- 2 files changed, 29 insertions(+), 81 deletions(-) diff --git a/README.rst b/README.rst index d031186..d85fc53 100644 --- a/README.rst +++ b/README.rst @@ -49,7 +49,7 @@ Extract sources and run .. code-block:: console - $ python setup.py install + $ python3 setup.py install and add an *RecorderPath* property of *MacroServer* with its value defining the package location, e.g. @@ -60,7 +60,7 @@ defining the package location, e.g. Debian packages """"""""""""""" -Debian Bookworm, Bullseye, Buster and Ubuntu Lunar, Jammy and Focal packages can be found in the HDRI repository. +Debian Bookworm, Bullseye, Buster and Ubuntu Oracular, Noble Jammy packages can be found in the HDRI repository. To install the debian packages, add the PGP repository key @@ -82,7 +82,7 @@ Finally, for python2.7 .. code-block:: console $ apt-get update - $ apt-get install python-sardana-nxsrecorder + $ apt-get install python3-sardana-nxsrecorder and set the RecoderPath property of MacroServer with @@ -90,34 +90,15 @@ and set the RecoderPath property of MacroServer with $ apt-get install sardana-nxsrecorder -For python3 - -.. code-block:: console - - $ apt-get update - $ apt-get install python3-sardana-nxsrecorder - $ apt-get install sardana-nxsrecorder3 To instal other NexDaTaS packages -.. code-block:: console - - $ apt-get install python-nxswriter nxsconfigserver-db python-nxsconfigserver nxsconfigtool python-nxstools nxswriter nxsconfigserver nxsrecselector - -or for python 3 - .. code-block:: console $ apt-get install python3-nxswriter nxsconfigserver-db python3-nxsconfigserver nxsconfigtool3 python3-nxstools nxswriter3 nxsconfigserver3 and -.. code-block:: console - - $ apt-get install python-nxsrecselector nxsrecselector nxselector - -or for python3 - .. code-block:: console $ apt-get install python3-nxsrecselector nxsrecselector3 nxselector3 diff --git a/man/sardananxsrecorder.1 b/man/sardananxsrecorder.1 index 05abb0b..83bb2e8 100644 --- a/man/sardananxsrecorder.1 +++ b/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" "Jul 19, 2024" "3.29" "Sardana NeXus Recorder" +.TH "SARDANANXSRECORDER" "1" "Nov 07, 2024" "3.29" "Sardana NeXus Recorder" .SH NAME sardananxsrecorder \- sardananxsrecorder Documentation .sp @@ -65,7 +65,7 @@ Extract sources and run .sp .nf .ft C -$ python setup.py install +$ python3 setup.py install .ft P .fi .UNINDENT @@ -79,7 +79,7 @@ defining the package location, e.g. .sp .SS Debian packages .sp -Debian Bookworm, Bullseye, Buster and Ubuntu Lunar, Jammy and Focal packages can be found in the HDRI repository. +Debian Bookworm, Bullseye, Buster and Ubuntu Oracular, Noble Jammy packages can be found in the HDRI repository. .sp To install the debian packages, add the PGP repository key .INDENT 0.0 @@ -114,7 +114,7 @@ Finally, for python2.7 .nf .ft C $ apt\-get update -$ apt\-get install python\-sardana\-nxsrecorder +$ apt\-get install python3\-sardana\-nxsrecorder .ft P .fi .UNINDENT @@ -132,38 +132,12 @@ $ apt\-get install sardana\-nxsrecorder .UNINDENT .UNINDENT .sp -For python3 -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C -$ apt\-get update -$ apt\-get install python3\-sardana\-nxsrecorder -$ apt\-get install sardana\-nxsrecorder3 -.ft P -.fi -.UNINDENT -.UNINDENT -.sp To instal other NexDaTaS packages .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C -$ apt\-get install python\-nxswriter nxsconfigserver\-db python\-nxsconfigserver nxsconfigtool python\-nxstools nxswriter nxsconfigserver nxsrecselector -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -or for python 3 -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C $ apt\-get install python3\-nxswriter nxsconfigserver\-db python3\-nxsconfigserver nxsconfigtool3 python3\-nxstools nxswriter3 nxsconfigserver3 .ft P .fi @@ -176,18 +150,6 @@ and .sp .nf .ft C -$ apt\-get install python\-nxsrecselector nxsrecselector nxselector -.ft P -.fi -.UNINDENT -.UNINDENT -.sp -or for python3 -.INDENT 0.0 -.INDENT 3.5 -.sp -.nf -.ft C $ apt\-get install python3\-nxsrecselector nxsrecselector3 nxselector3 .ft P .fi @@ -361,9 +323,14 @@ The NeXus file recorder uses the following sardana environment variables \fBNeXusWriterModes\fP \fI(list)\fP \- a list of strategy modes e.g. \fBNOINIT\fP, \fBNOSTEP\fP, \fBNOFINAL\fP, \fBMESH\fP, \fBVDS\fP separated by commas .IP \(bu 2 \fBScanNames\fP \fI(bool)\fP \- special mode of using ScanName directories i.e. -* \fBTrue\fP: the master file in ScanName directory, -* \fBFalse\fP: Themaster file in grouping ScanName directory, -* \fBNone\fP (or undefined): standard mode where the master files are outside ScanName directory +.INDENT 2.0 +.IP \(bu 2 +\fBTrue\fP: the master file in the ScanName directory, +.IP \(bu 2 +\fBFalse\fP: the master file in the grouping ScanName directory (e.g. without ScanID), +.IP \(bu 2 +\fBNone\fP (or undefined): standard mode where the master files are outside the ScanName directory +.UNINDENT .IP \(bu 2 \fBScanNamesNoGrouping\fP \fI(bool)\fP \- do not perform grouping when \fBScanNames\fP is \fBFalse\fP .IP \(bu 2 @@ -389,9 +356,9 @@ constructor .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBfilename\fP (\fI\%str\fP) \-\- ScanFile name +\fBfilename\fP (\fI\%str\fP) – ScanFile name .IP \(bu 2 -\fBmacro\fP (\fI\%sardana.macroserver.macro.Macro\fP) \-\- macro object +\fBmacro\fP (\fI\%sardana.macroserver.macro.Macro\fP) – macro object .UNINDENT .UNINDENT .INDENT 7.0 @@ -403,13 +370,13 @@ adds custom data to configuration variables, i.e. from macros .B Parameters .INDENT 7.0 .IP \(bu 2 -\fBvalue\fP (\fIany\fP) \-\- variable value +\fBvalue\fP (\fIany\fP) – variable value .IP \(bu 2 -\fBname\fP (\fI\%str\fP) \-\- variable name +\fBname\fP (\fI\%str\fP) – variable name .IP \(bu 2 -\fBgroup\fP (\fI\%str\fP) \-\- variable group inside variable dictionary +\fBgroup\fP (\fI\%str\fP) – variable group inside variable dictionary .IP \(bu 2 -\fBremove\fP (\fI\%bool\fP) \-\- if True variable will be removed +\fBremove\fP (\fI\%bool\fP) – if True variable will be removed .UNINDENT .UNINDENT .UNINDENT @@ -424,7 +391,7 @@ and closes the nexus file .INDENT 7.0 .TP .B Parameters -\fBrecordlist\fP (\fBsardana.macroserver.scan.scandata.RecordList\fP) \-\- sardana record list +\fBrecordlist\fP (\fBsardana.macroserver.scan.scandata.RecordList\fP) – sardana record list .UNINDENT .UNINDENT .INDENT 7.0 @@ -438,7 +405,7 @@ and records in INIT mode .INDENT 7.0 .TP .B Parameters -\fBrecordlist\fP (\fBsardana.macroserver.scan.scandata.RecordList\fP) \-\- sardana record list +\fBrecordlist\fP (\fBsardana.macroserver.scan.scandata.RecordList\fP) – sardana record list .UNINDENT .UNINDENT .INDENT 7.0 @@ -452,7 +419,7 @@ and records in INIT mode .INDENT 7.0 .TP .B Parameters -\fBrecord\fP (\fBsardana.macroserver.scan.scandata.Record\fP) \-\- sardana record list +\fBrecord\fP (\fBsardana.macroserver.scan.scandata.Record\fP) – sardana record list .UNINDENT .UNINDENT .INDENT 7.0 @@ -510,12 +477,12 @@ indent level. An indent level of 0 will only insert newlines. None is the most compact representation. .sp If specified, separators should be an (item_separator, key_separator) -tuple. The default is (\(aq, \(aq, \(aq: \(aq) if \fIindent\fP is \fBNone\fP and -(\(aq,\(aq, \(aq: \(aq) otherwise. To get the most compact JSON representation, -you should specify (\(aq,\(aq, \(aq:\(aq) to eliminate whitespace. +tuple. The default is (’, ‘, ‘: ‘) if \fIindent\fP is \fBNone\fP and +(‘,’, ‘: ‘) otherwise. To get the most compact JSON representation, +you should specify (‘,’, ‘:’) to eliminate whitespace. .sp If specified, default is a function that gets called for objects -that can\(aqt otherwise be serialized. It should return a JSON encodable +that can’t otherwise be serialized. It should return a JSON encodable version of the object or raise a \fBTypeError\fP\&. .INDENT 7.0 .TP @@ -524,7 +491,7 @@ default encoder .INDENT 7.0 .TP .B Parameters -\fBobj\fP (\fI\%object\fP or \fIany\fP) \-\- numpy array object +\fBobj\fP (\fI\%object\fP or \fIany\fP) – numpy array object .UNINDENT .UNINDENT .UNINDENT