.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.8.
.TH YADE "1" "November 2020" "Yade version: 2020.01a" "User Commands"
.SH NAME
Yade \- manual page for Yade version: 2020.01a
.SH DESCRIPTION
usage: yade [options] [ simulation.xml[.bz2] | script.py [script options]]
.PP
Yade: open\-source platform for dynamic compuations. It is an extensible opensource framework for discrete numerical models, focused on Discrete Element
Method. The computation parts are written in c++ using flexible object model,
allowing independent implementation of new algorithms and interfaces. Python
is used for rapid and concise scene construction, simulation control,
postprocessing and debugging. Available features: ['BoostLog', 'Odeint',
\&'VTK', 'OpenMP', 'GTS', 'GUI\-Qt5', 'CGAL', 'PFVFLOW', 'PFVFLOW', 'LINSOLV',
\&'MPI', 'TWOPHASEFLOW', 'SPH', 'FEMLIKE', 'GL2PS', 'LBMFLOW', 'THERMAL',
\&'PotentialParticles']. Homepage http://www.yade\-dem.org, code hosted at
http://www.launchpad.net/yade.
.SS "optional arguments:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-v\fR, \fB\-\-version\fR
Print version and exit.
.TP
\fB\-j\fR THREADS, \fB\-\-threads\fR THREADS
Number of OpenMP threads to run; defaults to 1.
Equivalent to setting OMP_NUM_THREADS environment
variable.
.TP
\fB\-\-cores\fR CORES
Set number of OpenMP threads (as \e\-\e\-threads) and in
addition set affinity of threads to the cores given.
Please provide a string with comma\-separated core\-ids.
.TP
\fB\-\-update\fR UPDATESCRIPTS [UPDATESCRIPTS ...]
Update deprecated class names in given script(s) using
text search & replace. Changed files will be backed up
with ~ suffix. Exit when done without running any
simulation.
.TP
\fB\-\-nice\fR NICE
Increase nice level (i.e. decrease priority) by given
number.
.TP
\fB\-x\fR
Exit when the script finishes
.TP
\fB\-f\fR VERBOSITY
Set "Default" filter for logging https://yadedem.org/doc/prog.html#logging, default is \fB\-f3\fR for all
classes.
.TP
\fB\-n\fR
Run without graphical interface (equivalent to
unsetting the DISPLAY environment variable)
.TP
\fB\-\-test\fR
Run regression test suite and exit; the exists status
is 0 if all tests pass, 1 if a test fails and 2 for an
unspecified exception.
.TP
\fB\-\-checks\fR
Run a series of user\-defined check tests as described
in \fI\,/yade/scripts/checks\-and\-tests/checks/README\/\fP and
https://yade\-dem.org/doc/prog.html#regression\-tests
.TP
\fB\-\-performance\fR
Starts a test to measure the productivity
.TP
\fB\-L\fR IMPLIBRARIES, \fB\-\-libs\fR IMPLIBRARIES
import libraries at startup before importing yade
libs. May be used when the ordering of imports matter
(see fixed bug (on old site)
https://bugs.launchpad.net/yade/+bug/1183402 and
discussion in https://gitlab.com/yadedev/trunk/issues/18). The option can be used multiple
times, as in "yade \fB\-Llib1\fR \fB\-Llib2\fR"
.SH "SEE ALSO"
The full documentation for
.B Yade
is maintained as a Texinfo manual.  If the
.B info
and
.B Yade
programs are properly installed at your site, the command
.IP
.B info Yade
.PP
should give you access to the complete manual.