.TH yade 1 "2012-7-4" yade
.SH NAME
.B yade 
\- open-source platform for dynamic computations

.SH SYNOPSIS
.B yade
[options] [ simulation.xml[.bz2] | script.py [script options]]


.SH DESCRIPTION
.B yade 
Extensible open-source 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 alogrithms and interfaces. Python is used for rapid and concise scene construction, simulation control, postprocessing and debugging.



See http://www.yade-dem.org/ for documentation and http://www.launchpad.net/yade for the project itself.

This is version  with features cgal,gts,opengl,openmp,qt4,vtk.
.SH OPTIONS
.IP "--version"
show program's version number and exit
.IP "--help, -h"
show this help message and exit
.IP "--threads=THREADS, -j THREADS"
Number of OpenMP threads to run; defaults to 1. Equivalent to setting OMP_NUM_THREADS environment variable.
.IP "--cores=CORES"
Set number of OpenMP threads (as \-\-threads) and in addition set affinity of threads to the cores given.
.IP "--update"
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.
.IP "--nice=NICE"
Increase nice level (i.e. decrease priority) by given number.
.IP "-x"
Exit when the script finishes
.IP "-n"
Run without graphical interface (equivalent to unsetting the DISPLAY environment variable)
.IP "--generate-manpage=FILE"
Generate man page documenting this program and exit
.IP "--rebuild"
Re-run build in the source directory, then run the updated yade with the same command line except \-\-rebuild. The build profile for this build (deb) and its stored parameters will be used.
.IP "--test"
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.
.IP "--debug"
Run the debug build, if available.
.IP "--checks"
Run a series of user-defined check tests as described in /tmp/buildd/yade-0.80.1/scripts/checks-and-tests/checks/README
.IP "--performance"
Starts a test to measure the productivity
.IP "--no-gdb"
Do not show backtrace when yade crashes (only effective with \-\-debug).
.SH SEE ALSO
yade-batch (1)
.SH COPYRIGHT 
© 2003--2012 Yade Developers Team

This program is free software; you can redistribute it and/or modify 
it under the terms of the GNU General Public License as published 
by the Free Software Foundation; either version 2 of the License, 
or (at your option) any later version.

This program is distributed in the hope that it will be useful, 
but WITHOUT ANY WARRANTY; without even the implied warranty of 
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 
GNU General Public License for more details.

You should have received a copy of the GNU General Public License 
along with this program; if not, write to the Free Software 
Foundation, Inc., 59 Temple Place, Suite 330, Boston, 
MA 02111-1307 USA.


.SH BUGS 
Please report bugs to the project's bug tracker at
.br
http://bugs.launchpad.net/yade

.SH AUTHOR
Yade Developers Team (http://www.launchpad.net/~yade-dev)