.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH SICONOS_COMPARE "1" "February 2024" "siconos_compare 4.5.0" "User Commands"
.SH NAME
siconos_compare \- Numerically compare the contents of two Siconos mechanics-IO HDF5 simulation files.
.SH DESCRIPTION
usage: siconos_compare [\-h] [\-\-columns <colspec>] [\-\-start <time>]
.TP
[\-\-end <time>] [\-\-interval <time>]
[\-\-threshold <float>] [\-V]
<file> <file>
.PP
Description: Numerically compare the contents of two Siconos mechanics\-IO HDF5
simulation files. Sole output on standard output shall be the maximum
difference between the columns selected for comparison. Return code 0 will be
returned if maximum difference is less than the threshold, otherwise 1 will be
returned if greater, or 2 if the files could not be opened or do not contain
the necessary tables. Non\-matching time indices shall be considered as failing
the comparison.
.SS "positional arguments:"
.TP
<file>
input files (HDF5)
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-\-columns\fR <colspec>, \fB\-c\fR <colspec>
list of columns to include in the comparison
(0\-indexed, comma\-separated, may be prefixed with
table name, and multiple lists separated by semicolon,
e.g., "dynamic:0,1,2;cf:0,1,2"; default
table="dynamic"). See Siconos HDF5 file format docs
for meaning of columns.
.TP
\fB\-\-start\fR <time>
start time in seconds from beginning the comparison
.TP
\fB\-\-end\fR <time>
end time in seconds end the comparison
.TP
\fB\-\-interval\fR <time>
amount of time after start to compare
.TP
\fB\-\-threshold\fR <float>
threshold for comparison
.TP
\fB\-V\fR, \fB\-\-version\fR
show program's version number and exit
.SH "SEE ALSO"
.I The Siconos Software Documentation
.TP
http://siconos.gforge.inria.fr