YADE

Overview

Yade is an extensible open-source framework for discrete numerical models, focused on Discrete Element Method. The computation parts are written in c++ and Python is used for rapid and concise scene construction, simulation control, postprocessing and debugging.

Version 0.97.0is installed on the CSF.

Restrictions on use

There are no restrictions on access.

Please make sure you read the “Acknowledging Yade” section if you plan to cite Yade in publications.

Set up procedure

To access the software you must first load the modulefile:

module load apps/gcc/yade/0.97.0

Running the application

Please do not run Yade on the login node. Jobs should be submitted to the compute nodes via batch or via qrsh if running interactively.

Serial batch job submission

Make sure you have the modulefile loaded then create a batch submission script, for example:

#!/bin/bash
#$ -S /bin/bash
#$ -cwd
### The above uses the current directory where you should have all relevant files
#$ -V
### The above inherits your user environment from the login node i.e. so it can find commands

yade-batch arg1 arg2

Submit the jobscript using:

qsub scriptname

Parallel batch job submission

Given an example parallel jobscript, including suitable PE

Interactive use via the Python console

Yade will use ipython to give an interactive shell. This must not be run on the login node. Instead is should be started via qrsh as follows:

module load apps/gcc/yade/0.97.0
qrsh -l inter -l short -cwd -V yade
  #
  # use twoday instead of short if running a longer simulation interactively
  #

You should see a Yade shell prompt appear, similar to:

Welcome to Yade 0.97.0
TCP python prompt on localhost:9000, auth cookie `ueacsk'
XMLRPC info provider on http://localhost:21000
[[ ^L clears screen, ^U kills line. F8 plot. ]]

Yade [1]:

To exit the shell (which will terminate your interactive session) use exit.

Further info

• Yade website
• Yade tutorial

Updates

None.