params Parameter Sweep

Introduction

A Parameter Sweep runs multiple simulations while systematically varying one or more outputs to study their effects.

  1. Define the base model for your parameter sweep.

  2. Click Workflow -> Create Parameter Sweep to create a new parameter sweep.

  3. The Workflow tab will appear in the model tree.

  4. Go to the workflow tab and click on the Parameter Sweep object.

  5. Click Edit Parameter Sweep in the context-specific toolbar.

  6. Edit the parameter sweep table. This form supports copy/paste. You are encouraged to use Excel in another window and copy the data into the form from there for larger parameter sweeps.

  7. Click OK.

  8. Save your document.

Exporting the Sweep

The cases are exported to the directory you choose, with each case in its own sub-directory named after the Case Name you specify on the parameter sweep table. Both the pre-processor document and solver files are saved during this export step.

  1. Click Workflow -> Export Parameter Sweep.

  2. Choose a directory where the cases will be exported and saved.

  3. Click OK.

Once the cases are exported, you can manually load them into the M-Star Queue or process them in your own system.

Running the Sweep

  1. Click Workflow -> Run Parameter Sweep.

  2. Choose an output directory.

  3. Click OK.

  4. The cases are exported.

  5. The Queue GUI is opened up with the parameter sweep loaded.

  6. See M-Star Queue for more information on processing queues.

../../_images/parameter_sweep_form.JPG

Parameter Sweep Toolbar

Context-Specific Toolbar Forms

Description

addv Add Variable

The Add Variable window opens a selection of properties to add as a variable.

param Edit Parameter Sweep

The Edit Parameter Sweep window.

help Help

The Help command launches the M-Star reference documentation in your web browser.

For a full description of each option, see Context-Specific Toolbar selections.

Additional Resources

For more on this subject, check out the following:

How-To Guides