.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH SICONOS_RUN "1" "February 2024" "siconos_run 4.5.0" "User Commands"
.SH NAME
siconos_run \- Run a pre-generated Siconos mechanics-IO HDF5 simulation file.
.SH DESCRIPTION
usage: siconos_run [\-h] [\-T time] [\-p period] [\-e interval] [\-f Hz] [\-V]
.IP
filename
.PP
Description: Run a pre\-generated Siconos mechanics\-IO HDF5 simulation file.
.SS "positional arguments:"
.TP
filename
simulation file (HDF5)
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-T\fR time
time in seconds to run until (default T=1 second)
.TP
\fB\-p\fR period, \fB\-\-period\fR period
time in seconds between frames (default p=5e\-3)
.TP
\fB\-e\fR interval, \fB\-\-every\fR interval
output every nth frame (default=1)
.TP
\fB\-f\fR Hz, \fB\-\-frequency\fR Hz
alternative to \fB\-p\fR, specify simulation frequency in Hz
(default=200 Hz)
.TP
\fB\-V\fR, \fB\-\-version\fR
show program's version number and exit
.PP
This script only provides a basic interface for the most common simulation
options. For more complex options, or to specify behaviour such as
controllers, you must create a custom simulation script. If a partiallycompleted simulation is found, it will be continued from the last time step
until T. Note that most example scripts do not use this program, and simply
define and then run the simulation in the same script.
.SH "SEE ALSO"
.I The Siconos Software Documentation
.TP
http://siconos.gforge.inria.fr