<< Click to Display Table of Contents >> Navigation:  Flexcom > User Interface > Running Analyses >
Command-Line Batch Runner

Overview

The Command-Line Batch Runner is specifically designed for users who prefer to use Flexcom from the command line rather than the user interface. This module allows you to kick-off a large number of simulations, stating the preferred execution order (e.g. taking restart file dependencies into account), controlling the number of simulation performed in parallel, and examining an informative CSV file on batch completion. Power users who already have their own batch scripts may wish to use their existing tools to assemble the file list, but most users will likely prefer to allow to module to automatically assemble the list for them, by passing a folder name, or a keyword file name, rather than the file list.

Simulations are executed in parallel for efficiency. The standalone batch module is also aware of many processing units are available on your machine, and endeavours to continually match the number of analyses in progress with the number of available processing units. Hence its capabilities are quite similar to those provided by the Analysis Status View, but without the same level of detail provided by its live status updates.

The execution module has two possible modes of operation:

The list file has the following format:

Keyword file, Dependent line number (optional)

Keyword file, Dependent line number (optional)

Keyword file, Dependent line number (optional)

and so on, until all keyword files have been specified.

Keyword file can contain a full file path, a relative file path, or simply a keyword file name on its own. In the absence of a file path, the keyword file is assumed to be located in the same folder as the executable. This is unlikely, unless you have copied the executable from the installation folder into your local working folder. Dependent line number indicates other lines in the list file which must be executed before this specific keyword file can be executed.

Command Line Arguments

The executable accepts the following command line arguments:

FLEXCOMBATCHRUNNER FOLDER NAME or FILE NAME [/N MAXPARALLEL] [/F FLEXCOMPATH] [/O OUTPUTFILE] [/P POSTPROCONLY] [/NW NOWARN]

 

•FlexcomBatchRunner. The full path to the batch runner program. The executable is called FlexcomBatchRunner.exe and is located in your local installation folder. The location varies depending on which version of Flexcom you have installed, but will be typically something like... "C:\Program Files\Wood\Flexcom\Version 2025.1.3\bin\FlexcomBatchRunner.exe". Note that if the file path contains spaces, you must enclose the character expression in quotation marks.

•Folder Name. The name and location of a folder containing Flexcom keyword files. The location depends on where your local working directory is located. Let's suppose you wish to run one of the standard Flexcom examples set. The project folder for Example B1 might be as follows: "C:\Users\Public\Documents\Wood\Flexcom\Version 2025.1.3\Example Projects\B - Steel Catenary Risers\01 - Steel Catenary Riser".

•File Name. The name and location of a file containing a list of Flexcom simulations to be executed. Again the location depends on where your local working directory is located.  

•MaxParallel: The maximum number of processes to run in parallel. The actual value used by the batch runner will be the minimum of (i) MaxParallel, (ii) the maximum number of available processors on your machine, and (iii) the number of processors supported by your licence agreement.

•FlexcomPath: The full path to the location where the Flexcom executables are stored. This defaults to the location of the batch runner program.

•OutputFile: The name and location of a CSV file which contains a summary of the batch file output. This defaults to FlexcomBatchRunner.csv, located in the current working folder.

•PostprocOnly means that Flexcom runs post-processing only (i.e. skips finite element simulation and proceeds directly to post-processing).

•NoWarn suppresses warning messages which occur during keyword pre-processing (this may be useful if a particular model issues a large number of similar warning messages which you are satisfied to accept).

Operation

Folder Mode

To execute all simulations contained within the Example B2 folder and its sub-folders:

•Open a command prompt window

•Type the execution command as follows: "Executable Name" "Folder Name"

▪e.g. "C:\Program Files\Wood\Flexcom\Version 2025.1.3\bin\FlexcomBatchRunner.exe" "C:\Users\Public\Documents\Wood\Flexcom\Version 2025.1.3\Example Projects\B - Steel Catenary Risers\01 - Steel Catenary Riser"

•Press return to start the batch

List Mode

To execute all simulations contained within the Example B2 folder:

•Create a text file, call it something like "Example B2 File List.txt", in the Example B2 folder.

•Assemble a list of keyword files as follows. The numbering on the left indicates line numbers in the list file (as opposed to specified values).

1.        B1-SCR-static.keyxm

2.        B1-SCR-offset.keyxm, 1

3.        B1-SCR-hangoff.keyxm, 2

4.        B1-SCR-current.keyxm, 3

5.        B1-SCR-modal.keyxm, 4

6.        B1-SCR-dynamic-1-td.keyxm, 4

7.        B1-SCR-dynamic-2-td.keyxm, 4

8.        B1-SCR-dynamic-3-td.keyxm, 4

9.        B1-SCR-dynamic-1-fd.keyxm, 4

10.        B1-SCR-dynamic-2-fd.keyxm, 4

11.        B1-SCR-dynamic-3-fd.keyxm, 4

•Save the list file

•Open a command prompt window

•Type the execution command as follows: "Executable Name" "List File Name"

▪e.g. "C:\Program Files\Wood\Flexcom\Version 2025.1.3\bin\FlexcomBatchRunner.exe" "C:\Users\Public\Documents\Wood\Flexcom\Version 2025.1.3\Example Projects\B - Steel Catenary Risers\01 - Steel Catenary Riser/Example B2 File List.txt"

•Press return to start the batch