Configuring your simulation - AWS SimSpace Weaver
Simulation configuration parameters

Configuring your simulation

A simulation schema (or schema) is a YAML-formatted text file that specifies the configuration for a simulation. You can use the same schema to start multiple simulations. The schema file is located in the project folder for your simulation. You can use any text editor to edit the file. SimSpace Weaver only reads your schema when it starts the simulation. Any edits that you make to a schema file only affect new simulations that you start after the edits.

Docker

To configure your simulation, edit your simulation schema file:

project-folder\tools\project-name-schema.yaml

You upload the simulation schema when you create a new simulation. The quick start helper script for your project will upload the schema as part of its process to build your simulation: 

project-folder\tools\windows\quick-start-project-name-cli.bat

You can also use the upload schema helper script for your project if you aren't using the quick start script to build your simulation: 

project-folder\tools\windows\upload-schema-project-name.bat
WSL
Important

We provide these instructions for your convenience. They are for use with Windows Subsystem for Linux (WSL), and are unsupported. For more information, see Set up your local environment for SimSpace Weaver.

You configure your simulation by editing its simulation schema file:

project-folder/tools/project-name-schema.yaml

You upload the simulation schema when you create a new simulation. The quick start helper script for your project will upload the schema as part of its process to build your simulation: 

project-folder/tools/linux/quick-start-project-name-cli.sh

You can also use the upload schema helper script for your project if you aren't using the quick start script to build your simulation: 

project-folder/tools/linux/upload-schema-project-name.sh
Important

If you use AWS IAM Identity Center or named profiles for the AWS Command Line Interface (AWS CLI), you must use SimSpace Weaver app SDK version 1.12.1 or higher. The latest version is 1.16.0. For information about SimSpace Weaver versions, see SimSpace Weaver versions. The SimSpace Weaver app SDK scripts use the AWS CLI. If you use IAM Identity Center, you can either copy your IAM Identity Center profile for the AWS CLI to your default profile or provide the name of your IAM Identity Center profile to SimSpace Weaver app SDK scripts with the --profile cli-profile-name parameter. For more information, see Configuring the AWS CLI to use AWS IAM Identity Center in the AWS Command Line Interface User Guide and Configuration and credential file settings in the AWS Command Line Interface User Guide.

Simulation configuration parameters

The simulation schema contains bootstrapping information, including:

  • Simulation properties – SDK version and compute configuration (type and number of workers)

  • Clocks – tick rate and tolerances

  • Spatial partitioning strategies – spatial topology (such as a grid), bounds, and placement groups (spatial partition grouping on workers)

  • Domains and their apps – app bucket, path, and launch command(s)

SimSpace Weaver uses your schema configuration to configure and arrange spatial partitions, launch apps, and advance the simulation at your specified tick rate.

Note

The create-project script in the SimSpace Weaver app SDK will automatically generate a simulation schema for you, based on the sample application.

The following topics describe the parameters in the simulation schema. For a full description of the simulation schema, see SimSpace Weaver simulation schema reference.

Topics