24. Batch Simulations with ProteusDS Queueing Manager (PQM)

The identification tag for this tutorial is PDS-ACL. Pregenerated input files for this tutorial are found in the folder named PDS-ACL in the provided tutorial input files.

24.1. Tutorial overview

This tutorial covers:

ProteusDS Queueing Manager (PQM) software
Running batches of simulations
Adding and managing simulations in PQM

24.2. ProteusDS Queuing Manager (PQM)

ProteusDS Queuing Manager (PQM) is included in the ProteusDS installation package and is used to manage and run batches of ProteusDS simulations. PQM is capable of running multiple concurrent simulations while maintaining a queue to execute upon completion of other running simulations. The PQM user interface is shown in Fig. 24.1.

Added simulations are listed in the main window. Details such as status, input folder, output folder, and progress are shown for each simulation. Each individual simulation has several options, such as specifying a custom output path, specifying a custom ProteusDS solver executable, launching in command prompt, and running in verbose mode. Options for managing a queue of simulations include moving a simulation up and down in the queue, and selecting the maximum number of concurrent simulations.

Fig. 24.1 ProteusDS Queuing Manager user interface

24.3. Creating a simulation

Create a new blank folder on your computer named Sim1.
Open PST and save a new simulation inside the Sim1 folder.
Create a new RigidBody named Float.
Add an ellipsoid named buoy to the RigidBody with $Ellipsoid buoy 0 0 0 0 0 0.
In the buoy library feature, set the x,y, and z diameters to be 1 m.
Set the RigidBody mass to 200 kg, and moments of inertia to 20 kgm² .
In the environment input file, turn on airy waves using $WaveType 1. Press Ctrl+r to resolve follower properties.
Set the wave height to 3 m and wave period to 10 s.
In the simulation input file, set the end time to 40 s.
Save the simulation and close PST.

24.4. Duplicating the simulation

Duplicate the Sim1 folder four times by copying and pasting. Name the pasted folders Sim2, Sim3, Sim4, and Sim5.

A typical batch of simulations will utilize the same base input files, with a few changed parameters for each unique simulation.

Adjust the wave heights of the duplicated simulations to 2.5 m, 2.0 m, 1.5 m, and 1.0 m, respectively.

This can be done by opening PST for each individual simulation and adjusting the wave height in the environment input file, or by opening and editing the env.ini file in a text editor.

24.5. Managing and running the simulation batch

Open ProteusDS Queueing Manager (PQM).

Simulations can be added to the queue by dragging and dropping the simulation folders into the user interface of PQM.

In windows explorer, navigate to the location containing the created simulation folders.
Select all of the simulation folders. Drag and drop the folders into the open PQM window.

Five new simulations will be added to the queue. The maximum number of concurrent simulations can be selected. When a simulation finishes, the next queued simulation will automatically begin running.

Set the maximum number of concurrent simulations to 3.

Simulations are executed in order from top to bottom of the simulation queue list. Simulations can be moved up or down in the queue by selecting the simulation and clicking the Move Selected Up or Move Selected Down buttons.

Click the green check mark button to begin simulating.

The status of each simulation is shown in the bottom right window, as shown in Fig. 24.2.

Fig. 24.2 Simulation status

The results of each simulation will be saved, by default, to the Results sub-folder of each respective simulation. Simulations can be paused or stopped during execution.

Select Sim1 and click the pause button. Once the simulation has been paused, it can be continued by clicking the resume button.
Click the stop button for Sim1. The reset button will now appear.

The reset button will delete the results directory of the simulation such that a new simulation can be started. Sim1 will now be added back into the queue, and another simulation will begin in its place. Once the first three simulations have been completed, the remaining simulations will begin to execute.