RUNS A CUSTOM APPLICATION TO WORK WITH SIMULATION DIRECTORY¶
Launches a user-defined executable against one or more simulation directories, passing custom environment variables, arguments, and a generated command file. Use this worker to integrate arbitrary post-processing or analysis tools into a d3VIEW workflow without writing a dedicated worker.
When to use¶
Tagged: commands, custom_application, environment_variables, executable, files, hpc, post-processing, simulation_directory.
Inputs¶
| Label | ID | Type | Default | Required | Description |
|---|---|---|---|---|---|
| Simulation | simulation_id | remote_lookup | — | One or more simulation records (remote lookup against the simulations dataType) whose directories will be passed to the custom application as DATA_SOURCE; leave null to supply the path another way. | |
| Needs Graphics | needs_graphics | select | yes | Whether the application requires a graphical display environment (e.g. OpenGL); set to ‘yes’ if the executable opens a GUI or renders images, ‘no’ for headless tools. Default: ‘yes’. | |
| Executable | application_exe | textarea | — | Full path or command name of the executable to run; must be accessible on all d3VIEW servers and target compute nodes (e.g. ‘/usr/local/bin/my_tool’). | |
| Environment Variables | application_env | textarea | — | Optional environment variables injected before execution; enter one variable per line in NAME=VALUE format (e.g. ‘OMP_NUM_THREADS=4’). | |
| Application Args | application_args | textarea | — | Command-line arguments appended directly to the executable invocation; use the same tokens (DATA_SOURCE, OUTPUT_DIR) here if the tool accepts paths as flags. | |
| Application Commands | application_commands | textarea | — | Script body written to a file before execution; use DATA_SOURCE as the placeholder for the simulation input directory and OUTPUT_DIR for the desired output path. | |
| Application Commands Type | application_commands_content_type | select | text | Content/format type of the commands file written to disk; currently only ‘text’ (plain text / shell script) is supported. Default: ‘text’. | |
| File Name | application_commands_write_filename | text | — | Filename (not full path) under which the commands body is saved before the executable is invoked (e.g. ‘run_commands.sh’); leave null to use an auto-generated name. | |
| Save Responses | save_responses | select | yes | Whether to parse and persist simulation responses extracted during execution to the d3VIEW response store; set to ‘no’ to skip response ingestion. Default: ‘yes’. |
Outputs¶
| Label | ID | Type | Description |
|---|---|---|---|
| Files | files | dataset | Dataset listing all files produced by the custom application in the OUTPUT_DIR after execution completes. |
| Extracted Responses | responses | dataset | Dataset of simulation responses (KPIs / time-history records) extracted and saved when save_responses is ‘yes’. |
| Number of Extracted Responses | num_responses | scalar | Scalar count of the response records extracted and stored; useful for downstream branching or validation checks. |
| STDOUT | stdout | textarea | Full standard-output text captured from the executable’s run; inspect for progress messages, warnings, or errors. |
Disciplines¶
- cae.postprocessing.extraction
- data.io.file
- platform.job_submission
- platform.workflow
Auto-generated from platform schema. Worker id: simulation_custom_application. Schema hash: 7e8d9ac5d897. Hand-curated docs in workerexamples/ override this page when present.