Commands

SimFactory’s functionality is divided into a number of separate commands. Each command can take both mandatory arguments as well as options.

List of Commands

The essential SimFactory commands are:

build	build cactus either locally or remotely
create	create a simulation
create-submit	create and submit a simulation
purge	purge a simulation
setup	interactively configure simfactory
stop	stop an active simulation
submit	submit a simulation
sync	sync cactus sourcetree to a remote machine

The following commands are also available:

archive	archive a simulation or an individual restart
checkout	checkout thorns using GetComponents
cleanup	clean up one or more simulations
create-run	create and run a simulation
execute	execute a command
get-archived-simulation	retrieve an archived simulation by simulationid
get-output-dir	get the output directory for a given simulation/restart
interactive	initiate an interactive session on a compute node
list-archived-simulations	list archived simulations
list-conf
list-configurations	list simfactory cactus configurations
list-machines	list all the machines in the machine database
list-sim
list-simulations	list simfactory cactus simulations
login	launch an interactive shell on a remote machine
print-mdb	print parsable mdb
print-mdb-entry	list information about a single machine
remove-submitscript	remove a submit script from a configuration
run	launch a simulation
run-debug	launch simulation using an interactive debugger
setup-silent	silently create a set of reasonable defaults
show-output	show the output of a simulation
whoami	what is the name of the machine simfactory is running on

Todo

Not all commands are documented

Common Options

All SimFactory commands take the following options. These are the important ones:

--remote <machine>

Execute command on a remote machine instead of the local machine

and these are the remaining ones:

--allocation <identifier>

CPU allocation to use

--argument <args>

Additional Arguments

--basedir <directory>

Base directory for simulations

--cdb <path>

INI file to use as the config database

--console

Output to console as opposed to writing to a log file

--force

Force cleanup even though a simulation may still be running.

--hostname <hostname>

Machine hostname

--localdir <directory>

Switch to directory

--machine <machinename>

Force the usage of a certain machine entry

--mdb <path>

INI file to use as the machine database

--num-smt <int>

Number of SMT threads (aka hyperthreads) to use

--num-threads <int>

Number of threads per process to use

--ppn <int>

Cores per node to request

--ppn-used <int>

Number of cores per node to use

--procs <int>

Total number of threads to use

--queue <identifier>

Queue to use for job submission

--remotecactuspath <directory>

the Cactus path to use on the remote system

--remotemachine <machine>

see –remote

--runscript <file>

run script for job execution

--scratchdir <path>

Scratch directory

--sourcebasedir <directory>

Base directory for source tree

--submitscript <file>

Submit script for job submission

--verbose

Be verbose with output

--walltime <HH:MM:SS>

Maximum run time for your simulation

Todo

These don’t all apply to all commands. Why are they in the common.ini file?

Todo

Include arguments and default values