LAUNCHES DOE STUDY FROM FILE¶
Launches a Design of Experiments (DOE) study by uploading solver input files directly, without requiring a pre-existing source simulation. One base simulation is created per uploaded main input file, and the study is populated with the provided sampling points (experiment values). Use this worker when you want to bootstrap a DOE study from raw deck files rather than cloning an existing simulation.
When to use¶
Tagged: base_simulation, doe, experiment, file_upload, hpc, lsdyna, optimization, sampling.
Inputs¶
| Label | ID | Type | Default | Required | Description |
|---|---|---|---|---|---|
| Main Input File | input_main_file | file | — | ✓ | One or more solver input deck files (e.g., LS-DYNA .k / .key files); one base simulation is created per file uploaded — at least one file is required. |
| Sampling Points | parameters | dataset | — | ✓ | Dataset of DOE sampling points where each row is one experiment and each column is a design variable value; must match the variable names referenced in the input deck. |
| HPC Config | hpc_settings | remote_lookup | — | Saved HPC configuration record (cluster, queue, CPU/memory settings) used to submit solver jobs; required unless Skip Submission is enabled. | |
| Include Files | input_include_files | file | — | Optional auxiliary or include files (sub-decks, material cards, geometry includes) that are referenced by the main input file and must be present on the solver node. | |
| Solver Type | solver_type | string | lsdyna | Solver identifier string (e.g., ‘lsdyna’); defaults to ‘lsdyna’ — change only when targeting a different supported solver. | |
| UnCompress Files | unzip_files | select | no | Set to ‘yes’ to decompress uploaded archive files before submission; defaults to ‘no’ when files are already uncompressed. | |
| Simulation Tags | tags | text | — | Comma-separated free-text labels applied to every simulation created in the study, useful for later filtering and reporting. | |
| Project | input_project_id | remote_lookup | — | Platform project under which the study and its simulations will be organized; leave blank to use the default project context. | |
| Study Name | study_name | scalar | — | ✓ | Human-readable name for the new DOE study; required when creating a new study — leave blank and populate study_id sibling to attach to an existing study. |
| Study Description | study_description | textarea | — | Optional free-text description of the study scope, objectives, or notes that will appear on the study record. | |
| Response Template | responsetemplate_id | remote_lookup | — | One or more response template IDs that define which KPIs/channels to extract from each simulation result; leave blank if no automated post-processing is needed. | |
| Type of Experiment Selection | baseline_only | select | yes | ✓ | Controls experiment execution scope: set to ‘no’ to run all DOE experiments, or leave at default ‘yes’ to submit only the baseline simulation. |
| Add to existing Study | add_to_existing_study | select | no | If a Study by name exists, use that study instead of creating a new study | |
| Skip Submission | skip_submission | select | no | ✓ | |
| Sleep Interval After Job Submission | sleep_after_submission | 1 | Number of seconds to sleep after each submission | ||
| Iteration number | iteration_number | 1 | If the DOE has more than one state, we can specify this here to include in the simulation name | ||
| Simulation Start Number | start_index | 1 | This number is associated with the Simulation starting with the baseline and incremented by 1 | ||
| Ignore Source Simulation | ignore_source | select | no | ✓ | |
| Format | format | select | no | ||
| Number of Random Sampling | num_random_sampling | 3 | If the option of sampling is set to Random, this number determines the number of random experiments to consider | ||
| Remove Simulations belonging to Study before creation | clean_simulations | select | no | ✓ | |
| Verify Template Extractions | verify_template | select | no | ||
| Reference Test | physicaltest_id | remote_lookup | — |
Outputs¶
| Label | ID | Type | Description |
|---|---|---|---|
| Study Id | study_id | text | Platform identifier (text) of the created or updated DOE study, usable as input to downstream analysis or reporting workers. |
| Simulations | simulations | dataset | Dataset listing every simulation record created within the study, including simulation IDs, statuses, and metadata. |
| Template | template_id | integer | Integer ID of the response template attached to the study; passes through to post-processing workers that need the template reference. |
| Responses | responses | dataset | Dataset of extracted KPI/response values collected from completed simulations according to the assigned response template. |
| Experiments with Simulation Ids | experiments_with_sim_ids | dataset | Dataset that maps each DOE experiment row (design variable values) to its corresponding platform simulation ID, enabling traceability. |
| Logs | logs | dataset | Dataset of submission and execution log messages for the study launch process, useful for debugging failed or incomplete experiments. |
Disciplines¶
- cae.solver
- design_exploration.doe
- platform.hpc_config
- platform.job_submission
- platform.workflow
Auto-generated from platform schema. Worker id: doe_study_launcher_from_file. Schema hash: cf978b339b18. Hand-curated docs in workerexamples/ override this page when present.