Step 1: Create a project - AWS SimSpace Weaver

Step 1: Create a project

The SimSpace Weaver app SDK distributable contains a script that creates a project from the bundled PathfindingSample project. You must run the script from its location in your file system. The script creates a project-name inside a path using the values that you provide at the command line.

Docker
To create a project
  1. At a Windows command prompt, change to your project folder.

    cd sdk-folder
  2. Run the create-project.bat script.

    .\create-project.bat --name project-name --path path

    The full command and parameter list follow.

    .\create-project.bat --name project-name --path path --app-sdk-version version-number --template template-name --overwriteproject
    Important

    Don't use a project name longer than 20 characters. Exceeding this limit might result in errors.

    Note

    If you receive a prompt to share a drive with Docker, choose Yes to share.

    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.

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.

To create a project
  1. At a Linux shell prompt, change to your project folder.

    cd sdk-folder
  2. Run the create-project.sh script.

    ./create-project.sh --name project-name --path path

    The full command and parameter list follow.

    ./create-project.sh --name project-name --path path --profile cli-profile-name --app-sdk-version version-number --template template-name --overwriteproject
    Important

    Don't use a project name longer than 20 characters. Exceeding this limit might result in errors.

    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.

Parameters
name

The name of your project.

path

The location of the project in your file system. The project structure can sometimes have long file paths that can exceed the path length limit in your operating system. We recommend that you use a path name that is as short as possible.

profile

The name of the AWS CLI profile that the script should use for authentication. For more information, see Configuration and credential file settings in the AWS Command Line Interface User Guide. This parameter is only available for the SimSpace Weaver app SDK version 1.12.1 or higher. For more information about SimSpace Weaver versions, see SimSpace Weaver versions.

app-sdk-version

(optional) The version of the SimSpace Weaver app SDK that your project uses. You will build and link your apps using this version. If the script doesn't find the version in the location of the distributable, or if you don't provide the version number, the script will automatically download the latest version.

template

(optional) A project template that the script will use to create your project. If you don't provide a template, the script will use the PathfindingSample. Valid values:

  • PathfindingSample – a sample application that uses a single worker.

  • MultiWorkerPathfindingSample – a version of the sample application that uses multiple workers.

overwriteproject

(optional) Use this option to overwrite an existing project folder with the same project name and path.