USING(1)

📦
version 2026.1.0 · 6 versions
, in ubuntu stonking

✨ USING(1) — the girlies' guide to Using ✨

okay bestie, sit down, grab a strawberry 🍓, because this is the manual page for Using — and yes, it's the manual page for Using python version: 3.14.6 (main, Jun 10 2026, 18:54:31) [GCC 15.2.0]. That's a whole mouthful, I know. It's a User Commands situation, and we're gonna get through it together 💅

🎀 NAME 🎀

Using — manual page for Using python version: 3.14.6 (main, Jun 10 2026, 18:54:31) [GCC 15.2.0]

💖 DESCRIPTION 💖

Alright so first things first, the vibe check: Using python version: 3.14.6 (main, Jun 10 2026, 18:54:31) [GCC 15.2.0]. That's the python energy we're running on, periodt. ✨

And here's the usage, copy it exactly or the terminal will simply not hear you:

usage: yade-double-batch [options] [ TABLE [SIMULATION.py] |
SIMULATION.py[/nCores] [...] ]

So basically yade-double-batch runs a yade simulation multiple times with different parameters. Iconic behavior, honestly. The devs wrote the details down here if you wanna go deeper, iykyk:

https://yade-dem.org/sphinx/user.html#batch-queuing-andexecution-yade-batch

Now, the way that you specify a batch — there are literally two options and both are valid, no gatekeeping:

  1. The TABLE route 🫶 — you give a parameter table called TABLE (and no shade, but it must not end in .py). Then either it's followed by exactly one SIMULATION.py (which must end in .py, no exceptions bestie), or the table itself contains a !SCRIPT column telling you which simulation to run.
  2. The multiple-scripts route ✨ — you just list a bunch of scripts. Each one can optionally carry a /nCores suffix to say how many cores that particular simulation gets (this lines up with the !THREADS column in the parameter table, cute right?). Example: sim.py/3.

🌸 options: 🌸

Here comes the main event, the whole cast of characters 👑

  • -h, --help — show this help message and exit. The classic. The goat. 🙈
  • -j, --jobs NUM — maximum number of simultaneous threads to run. Default is the number of cores, and it gets further limited by OMP_NUM_THREADS if the environment set that: 1.
  • -v, --version — print version and exit. Show off then dip 💅
  • --job-threads NUM — default number of threads for one job. A per-job setting can override it with the !THREADS (or !OMP_NUM_THREADS) column. Defaults to 1.
  • --force-threads — forces jobs to not use more cores than the maximum (see -j), even if the !THREADS colums says otherwise. Note: yes, the original really says colums. 🍓
  • --log FORMAT — the format of job log files. It must contain a $, % or @, which get replaced by script name, line number, or the description column respectively. Default: $.@.log.
  • --global-log FILE — filename where output of yade-batch itself gets redirected (as opposed to --log, which is about the jobs). If you don't specify it (that's the default), stdout/stderr are used.
  • -l, --lines LIST — which lines of TABLE to use, in the format 2,3-5,8,11-13. Default: all available lines in TABLE.
  • --nice NICE — nice value of the spawned jobs. Default: 10.
  • --cpu-affinity — bind each job to specific CPU cores. Cores get assigned in a quasi-random order, depending on availability at the moment the job is started. Each job can override this setting by setting the AFFINE column.
  • --executable FILE — name of the program to run. Default: /build/yademnvFJu/yade-2026.1.0/debian/tmp/usr/bin/yade-double. Jobs can override it with the !EXEC column.
  • --gnuplot FILE — gnuplot file where the gnuplot output from all jobs should be put together.
  • --dry-run — do not actually run. Useful for getting the gnuplot only, for instance. Fake it till you make it ✨
  • --http-wait — do not quit if still serving an overview over http repeatedly.
  • --plot-update TIME — interval (in seconds) at which job plots get updated even if they weren't requested via HTTP. Non-positive values will make the plots not be updated and saved unless requested via HTTP (see --plot-timeout for controlling the 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.
  • --plot-timeout TIME — maximum age (in seconds) of plots served over HTTP; they'll be updated if they're older than that. Default: 30 seconds.
  • --refresh TIME — refresh rate of automatically reloaded web pages (summary, logs, ...).
  • --timing COUNT — repeat each job COUNT times, and output a simple table with average/variance/minimum/maximum job duration. It's used for measuring how various parameters affect execution time. Jobs can override the global value with the !COUNT column. ⏱️
  • --timing-output FILE — with --timing, save the measured durations to FILE instead of writing them to standard output.
  • --randomize — randomize job order (within the constraints given by assigned cores). Chaos, but make it structured.
  • --disable-pynotify — disable screen notifications. Peace and quiet, we love her 😌
  • -L, --libs IMPLIBRARIES — import libraries at startup, before importing the yade libs. May be used when the ordering of imports matters (see e.g. https://bugs.launchpad.net/yade/+bug/1183402 /comments/3). The option can be used multiple times, as in "yade -Llib1 -Llib2".

And then the little flex at the bottom of the options, keep it verbatim bestie:

Yade version: 2026.1.0, features: LOGGER USEFUL_ERRORS COMPLEX_MP MPFR MPC VTK OPENMP GTS QT5 MPI LS_DEM FEMLIKE GL2PS LBMFLOW POTENTIAL_PARTICLES

She's got range. She's got features. 👑

🦋 SEE ALSO 🦋

The full documentation for Using is maintained as a Texinfo manual. If the info and Using programs are properly installed at your site, this command

info Using

should give you access to the complete manual. Go read, bestie, it's giving ✨educated✨.

okay that's the whole page, mwah 💖 — this was Using python version: 3.14.6 (... August 2026, footed with USING(1). slay, goodbye, drink water 🫶🌈

📦 where this page comes from