.TH yade-batch 1 "2012-7-4" yade-batch
.SH NAME
.B yade-batch 
\- batch system for computational platform Yade

.SH SYNOPSIS
.B yade\-batch
[options] [ TABLE [SIMULATION.py] | SIMULATION.py[/nCores] [...] ]


.SH DESCRIPTION
.B yade-batch 
Manage batches of computation jobs for the Yade platform; batches are described using text-file tables with parameters which are passed to individual runs of yade. Jobs are being run with pre-defined number of computational cores as soon as the required number of cores is available. Logs of all computations are stored in files and the batch progress can be watched online at (usually) http://localhost:9080. Unless overridden, the executable yade is used to run jobs.
.SH OPTIONS
.IP "--help, -h"
show this help message and exit
.IP "--jobs=NUM, -j NUM"
Maximum number of simultaneous threads to run (default: number of cores, further limited by OMP_NUM_THREADS if set by the environment: 4)
.IP "--job-threads=NUM"
Default number of threads for one job; can be overridden by per-job with !THREADS (or !OMP_NUM_THREADS) column. Defaults to 1.
.IP "--force-threads"
Force jobs to not use more cores than the maximum (see \-j), even if !THREADS colums specifies more.
.IP "--log=FORMAT"
Format of job log files: must contain a $, % or @, which will be replaced by script name, line number or by description column respectively (default: $.@.log)
.IP "--global-log=FILE"
Filename where to redirect output of yade-batch itself (as opposed to \-\-log); if not specified (default), stdout/stderr are used
.IP "--lines=LIST, -l LIST"
Lines of TABLE to use, in the format 2,3-5,8,11-13 (default: all available lines in TABLE)
.IP "--nice=NICE"
Nice value of spawned jobs (default: 10)
.IP "--cpu-affinity"
Bind each job to specific CPU cores; cores are assigned in a quasi-random order, depending on availability at the moment the jobs is started. Each job can override this setting by setting AFFINE column.
.IP "--executable=FILE"
Name of the program to run (default: /tmp/buildd/yade-0.80.1/debian/inst/bin/yade). Jobs can override with !EXEC column.
.IP "--rebuild"
Run executable(s) with \-\-rebuild prior to running any jobs.
.IP "--debug"
Run the executable with \-\-debug. Can be overriddenn per-job with !DEBUG column.
.IP "--gnuplot=FILE"
Gnuplot file where gnuplot from all jobs should be put together
.IP "--dry-run"
Do not actually run (useful for getting gnuplot only, for instance)
.IP "--http-wait"
Do not quit if still serving overview over http repeatedly
.IP "--generate-manpage=FILE"
Generate man page documenting this program and exit
.IP "--plot-update=TIME"
Interval (in seconds) at which job plots will be updated even if not requested via HTTP. Non-positive values will make the plots not being updated and saved unless requested via HTTP (see \-\-plot-timeout for controlling maximum age of those).  Plots are saved at exit under the same name as the log file, with the .log extension removed. (default: 120 seconds)
.IP "--plot-timeout=TIME"
Maximum age (in seconds) of plots served over HTTP; they will be updated if they are older. (default: 30 seconds)
.IP "--refresh=TIME"
Refresh rate of automatically reloaded web pages (summary, logs, ...).
.IP "--timing=COUNT"
Repeat each job COUNT times, and output a simple table with average/variance/minimum/maximum job duration; used for measuring how various parameters affect execution time. Jobs can override the global value with the !COUNT column.
.IP "--timing-output=FILE"
With \-\-timing, save measured durations to FILE, instead of writing to standard output.
.IP "--randomize"
Randomize job order (within constraints given by assigned cores).
.SH SEE ALSO
yade (1)
.br
https://yade-dem.org/sphinx/user.html#batch-queuing-and-execution-yade-batch
.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)