CrayLabs / SmartSim

SmartSim Infrastructure Library.
BSD 2-Clause "Simplified" License
235 stars 37 forks source link

LaunchSettings Documentation Page #751

Closed amandarichardsonn closed 1 month ago

amandarichardsonn commented 1 month ago

Description

What is the point of this feature? Why include it?

Implementation Strategy

LaunchSettings

  1. Overview
    • Overview of LaunchSettings
    • Brief description of LaunchSettings and the purpose with SS
  2. Supported Launchers
    • List of supported Launchers
    • Brief description of each launcher and the environments they are typically used in (emphasis on Dragon?)
    • Example scenarios where each launcher might be pref (TBD)
  3. Configuring LaunchSettings
    • Setting Launch Arguments
    • Explanation of how to set custom launch arguments
    • Example code snippets demonstrating how to configure launch arguments for different launchers
  4. Settings Environment variables
    • Explanation of how to set environment variables using LaunchSettings
    • Example code snippets demonstrating how to configure environment variables
  5. Examples
    • Detailed examples of configuring LaunchSettings for different launchers
    • Step-by-step walkthroughs of setting up and launching jobs with various launchers