Skip to content

Commit

Permalink
Issue 533: add --copy-map-error and --group-map-error to nxsfileinfo (#…
Browse files Browse the repository at this point in the history
…534)

* add --copy-map-error and  --group-map-error  to nxsfileinfo

* apply pep8
  • Loading branch information
jkotan authored Nov 28, 2023
1 parent 1f7a033 commit 188f717
Show file tree
Hide file tree
Showing 11 changed files with 636 additions and 607 deletions.
5 changes: 5 additions & 0 deletions ChangeLog
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
2023-11-28 Jan Kotanski <jankotan@gmail.com>
* add --copy-map-error to nxsfileinfo metadata (#534)
* add --group-map-error to nxsfileinfo metadata (#534)
* tagged as v3.53.0

2023-11-23 Jan Kotanski <jankotan@gmail.com>
* add --keywords to nxsfileinfo metadata (#529)
* add --raw to nxsfileinfo groupmetadata (#529)
Expand Down
7 changes: 5 additions & 2 deletions doc/nxsfileinfo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,7 @@ Options:
field json or yaml with map {output: input} or [[output, input],]
or a text file list to re-arrange metadata. The default:
'scientificMetadata.nxsfileinfo_parameters.copymap.value'
--copy-map-error Raise an error when the copy map file does not exist
--copy-map-file COPYMAPFILE
json or yaml file containing the copy map, see also --copy-map
-f FILEFORMAT, --file-format FILEFORMAT
Expand Down Expand Up @@ -362,8 +363,8 @@ Example
nxsfileinfo attachment -b p00 -i 2342342 -t 'HH water' -o ~/at2.json myscan_00124.fio
nxsfileinfo metadata
--------------------
nxsfileinfo groupmetadata
-------------------------

It groups scan metadata to one dataset

Expand All @@ -387,6 +388,8 @@ Options:
-g GROUPMAP, --group-map GROUPMAP
json or yaml map of {output: input} or [[output,
input],] or a text file list to re-arrange metadata
-e, --group-map-error
Raise an error when the group map file does not exist
-r GROUPMAPFILE, --group-map-file GROUPMAPFILE
json or yaml file containing the copy map, see also
-m METADATAFILE, --metadata METADATAFILE
Expand Down
38 changes: 19 additions & 19 deletions man/nxscollect.1
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
.\" Man page generated from reStructuredText.
.
.TH "NXSCOLLECT" "1" "Nov 28, 2023" "3.53" "NXSTools"
.SH NAME
nxscollect \- upload external images into NeXus/HDF5 file
.
.nr rst2man-indent-level 0
.
Expand Down Expand Up @@ -27,9 +30,6 @@ 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 "NXSCOLLECT" "1" "Nov 22, 2023" "3.52" "NXSTools"
.SH NAME
nxscollect \- upload external images into NeXus/HDF5 file
.SH DESCRIPTION
.sp
The nxscollect is a command\-line tool dedicated to collect detector images.
Expand Down Expand Up @@ -61,7 +61,7 @@ nexus_file nexus files to be collected
.B Options:
.INDENT 7.0
.TP
.B \-h\fP,\fB \-\-help
.B \-h\fP,\fB \-\-help
show this help message and exit
.TP
.BI \-c \ COMPRESSION\fR,\fB \ \-\-compression \ COMPRESSION
Expand All @@ -88,20 +88,20 @@ datatype of input data \- only for raw data, e.g.
shape of input data \- only for raw data, e.g.
\(aq[4096,2048]\(aq
.TP
.B \-s\fP,\fB \-\-skip_missing
.B \-s\fP,\fB \-\-skip_missing
skip missing files
.TP
.B \-r\fP,\fB \-\-replace_nexus_file
.B \-r\fP,\fB \-\-replace_nexus_file
if it is set the old file is not copied into a file
with .__nxscollect__old__* extension
.TP
.B \-\-test
.B \-\-test
execute in the test mode
.TP
.B \-\-h5py
.B \-\-h5py
use h5py module as a nexus reader/writer
.TP
.B \-\-h5cpp
.B \-\-h5cpp
use h5cpp module as a nexus reader/writer
.UNINDENT
.UNINDENT
Expand Down Expand Up @@ -142,7 +142,7 @@ nexus_file_path nexus files with the nexus directory to place the link
.B Options:
.INDENT 7.0
.TP
.B \-h\fP,\fB \-\-help
.B \-h\fP,\fB \-\-help
show this help message and exit
.TP
.BI \-n \ NAME\fR,\fB \ \-\-name \ NAME
Expand All @@ -151,17 +151,17 @@ link name
.BI \-t \ TARGET\fR,\fB \ \-\-target \ TARGET
link target with the file name if external
.TP
.B \-r\fP,\fB \-\-replace_nexus_file
.B \-r\fP,\fB \-\-replace_nexus_file
if it is set the old file is not copied into a file
with .__nxscollect__old__* extension
.TP
.B \-\-test
.B \-\-test
execute in the test mode
.TP
.B \-\-h5py
.B \-\-h5py
use h5py module as a nexus reader/writer
.TP
.B \-\-h5cpp
.B \-\-h5cpp
use h5cpp module as a nexus reader
.UNINDENT
.UNINDENT
Expand Down Expand Up @@ -205,7 +205,7 @@ Options:
.INDENT 3.5
.INDENT 0.0
.TP
.B \-h\fP,\fB \-\-help
.B \-h\fP,\fB \-\-help
show this help message and exit
.TP
.BI \-t \ DTYPE\fR,\fB \ \-\-dtype \ DTYPE
Expand Down Expand Up @@ -304,17 +304,17 @@ sepatated by \(aq,\(aq and different fields separated by \(aq;\(aq
or spaces e.g. \(aq:,0:50,: :,0:50,:\(aq where U means span
along the layout
.TP
.B \-r\fP,\fB \-\-replace\-nexus\-file
.B \-r\fP,\fB \-\-replace\-nexus\-file
if it is set the old file is not copied into a file
with .__nxscollect__old__* extension
.TP
.B \-\-test
.B \-\-test
execute in the test mode
.TP
.B \-\-h5cpp
.B \-\-h5cpp
use h5cpp module as a nexus reader
.TP
.B \-\-h5py
.B \-\-h5py
use h5py module as a nexus reader/writer
.UNINDENT
.UNINDENT
Expand Down
18 changes: 9 additions & 9 deletions man/nxsconfig.1
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
.\" Man page generated from reStructuredText.
.
.TH "NXSCONFIG" "1" "Nov 28, 2023" "3.53" "NXSTools"
.SH NAME
nxsconfig \- read NeXus Configuration Server settings
.
.nr rst2man-indent-level 0
.
Expand Down Expand Up @@ -27,9 +30,6 @@ 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 "NXSCONFIG" "1" "Nov 22, 2023" "3.52" "NXSTools"
.SH NAME
nxsconfig \- read NeXus Configuration Server settings
.SH DESCRIPTION
.sp
The nxsconfig program
Expand Down Expand Up @@ -132,25 +132,25 @@ show transformation parameters of given components
.B Options:
.INDENT 7.0
.TP
.B \-h\fP,\fB \-\-help
.B \-h\fP,\fB \-\-help
show this help message and exit
.TP
.BI \-s \ SERVER\fR,\fB \ \-\-server\fB= SERVER
configuration server device name
.TP
.B \-d\fP,\fB \-\-datasources
.B \-d\fP,\fB \-\-datasources
perform operation on datasources
.TP
.B \-m\fP,\fB \-\-mandatory
.B \-m\fP,\fB \-\-mandatory
make use mandatory components as well
.TP
.B \-p\fP,\fB \-\-private
.B \-p\fP,\fB \-\-private
make use private components, i.e. starting with \(aq__\(aq
.TP
.B \-n\fP,\fB \-\-no\-newlines
.B \-n\fP,\fB \-\-no\-newlines
split result with space characters
.TP
.B \-f\fP,\fB \-\-force
.B \-f\fP,\fB \-\-force
do not ask
.UNINDENT
.UNINDENT
Expand Down
Loading

0 comments on commit 188f717

Please sign in to comment.