.. _auto_simulation_create_from_file:

*CREATE SIMULATION FROM FILE*
=============================

Creates a new platform simulation record by uploading one or more input deck files, assigning it a name, solver type, and optional metadata such as project, loadcase, and template associations. Use this worker at the start of a workflow to register a file-based simulation (e.g. LS-DYNA) before submission or post-processing.

When to use
-----------

Tagged: ``create``, ``deck``, ``file_upload``, ``loadcase``, ``lsdyna``, ``project``, ``registration``, ``simulation``.

Inputs
------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20 20 20

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Simulation Name
     - input_sim_name
     - text
     - —
     - ✓
     - Human-readable name for the new simulation record; required and must be unique within the project.
   * - Simulation Description
     - input_sim_desc
     - textarea
     - —
     - 
     - Optional free-text description of the simulation, e.g. loadcase purpose or model version notes.
   * - Simulation Tags
     - input_sim_tags
     - text
     - —
     - 
     - Optional comma-separated tags to label the simulation for search and filtering in the platform.
   * - Main Input File
     - input_main_file
     - file
     - —
     - ✓
     - One or more primary solver input deck files (e.g. LS-DYNA .k / .key files) that define the simulation; required.
   * - Solver Type
     - solver_type
     - string
     - lsdyna
     - ✓
     - Solver backend to associate with this simulation (e.g. 'lsdyna'); defaults to 'lsdyna' and must match an installed solver on the platform.
   * - Template ID
     - input_template_id
     - remote_lookup
     - —
     - 
     - Optional platform template ID to apply predefined response definitions or workflow configuration to the new simulation; looked up from /api/user/projects.
   * - Project ID
     - input_project_id
     - remote_lookup
     - —
     - 
     - Optional platform project ID under which the simulation will be grouped; looked up from /api/user/projects — leave blank to use the default user project.
   * - Loadcase ID
     - input_loadcase_id
     - remote_lookup
     - —
     - 
     - Optional loadcase ID to associate this simulation with a specific test scenario or regulatory loadcase defined in the platform.
   * - Additional Files
     - input_include_files
     - file
     - —
     - 
     - Optional additional LS-DYNA include/keyword files (.k, .key, .dyn, .dyna, .inc, dynain) referenced by the main deck; up to 100 files may be attached.
   * - Responses
     - responses
     - vector
     - —
     - 
     - Optional repeatable response vector definitions (curve inputs) that configure which simulation outputs to extract after the run; see d3VIEW Glossary for format details.
   * - DeCompress Files
     - unzip_files
     - scalar
     - yes
     - 
     - Whether to automatically decompress any uploaded archive files before ingestion; accepts 'yes' (default) or 'no'.
   * - Test ID
     - physicaltest_id
     - remote_lookup
     - —
     - 
     - Optional physical test ID to link this simulation to a corresponding experimental test record for correlation purposes.
   * - System Model ID
     - systemmodel_id
     - remote_lookup
     - —
     - 
     - 
   * - HPC Setting Name
     - hpcjob_setting
     - remote_lookup
     - —
     - 
     - 
   * - Assemblies
     - assemblies
     - remote_lookup
     - —
     - 
     - 

Outputs
-------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20

   * - Label
     - ID
     - Type
     - Description
   * - New Simulation
     - simulation_id
     - integer
     - Integer ID of the newly created simulation record on the platform; use this as input to downstream solver-submission or post-processing workers.

Disciplines
-----------

- cae.preprocessing.deck_authoring
- cae.preprocessing.scenario
- platform.workflow

.. raw:: html

   <hr style="margin-top:2em">
   <p style="font-size:11px;color:#888">
   Auto-generated from <code>platform</code> schema. Worker id: <code>simulation_create_from_file</code>. Schema hash: <code>cbfffae7706a</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>