.. _auto_assembler_create_systemmodel_from_files:

*CREATE A SYSTEM MODEL FROM FILES*
==================================

Creates a System Model entity on the d3VIEW Assembler platform by ingesting one or more LS-DYNA deck files (keyword, include, or archive formats). Use this worker to register a new assembly — such as a BIW or chassis — from uploaded files and associate it with a project and design step.

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

Tagged: ``assembler``, ``assembly``, ``bIW``, ``chassis``, ``deck``, ``file_upload``, ``include_path``, ``keyword``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - System Model Name
     - name
     - text
     - —
     - ✓
     - Unique display name for the new System Model; used as its label in the Assembler graph and all downstream references — required.
   * - Description
     - description
     - textarea
     - —
     - 
     - Optional free-text description of the System Model's purpose or configuration; leave blank if no annotation is needed.
   * - Type
     - type
     - text
     - —
     - 
     - Assembly category string (e.g. 'BIW', 'Chassis', 'Closure') used for filtering and display in the Assembler graph; leave blank if not applicable.
   * - Color
     - color
     - color
     - #000000
     - ✓
     - Hex color code (default #000000) used to render this System Model's node in the Assembler graph visualisation; change to distinguish overlapping assemblies.
   * - Design Step
     - designstep_id
     - remote_lookup
     - —
     - 
     - Optional reference to an existing Design Step; links the System Model to a specific loadcase or configuration phase — leave unset if no design step is required.
   * - Project
     - project_id
     - remote_lookup
     - —
     - 
     - Optional reference to an existing Project; scopes the System Model within a project — leave unset for standalone / global models.
   * - Tags
     - tags
     - text
     - —
     - 
     - Comma-separated list of free-text tags (e.g. 'baseline,v2,frontal') for search and filtering of the System Model in the platform.
   * - Include Path Method
     - include_type
     - select
     - no_include_path
     - 
     - Controls whether an LS-DYNA *INCLUDE_PATH keyword is written into the assembled deck; choose 'include_path' to preserve directory references, default 'no_include_path' embeds files directly.
   * - Files
     - files
     - file
     - —
     - ✓
     - One or more LS-DYNA deck files (.key, .k, .dyn, .inc, .dyna, .incl) or archives (.zip, .tar) from which the System Model will be built — at least one file is required.
   * - Main Input File Name
     - main_input_file_name
     - text
     - Main.k
     - 
     - 
   * - Main Input Content
     - main_input_content
     - textarea
     - —
     - 
     - 
   * - Existing System Model Id
     - systemmodel_id
     - text
     - —
     - 
     - If specified, the existing system model is updated rather than creating a new one. Pass the integer ID of the system model to update.
   * - Parent Systemmodel
     - parent_id
     - remote_lookup
     - —
     - 
     - Parent from which the current Systemmodel was inherited

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - System Model ID
     - systemmodel_id
     - text
     - Platform-assigned unique identifier (integer or UUID string) of the newly created System Model; use this ID to reference the model in subsequent workflow workers.
   * - Files
     - files
     - dataset
     - Dataset record of all files ingested into the System Model, including resolved include paths; useful for auditing or passing to downstream preprocessing workers.

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

- cae.preprocessing.deck_authoring
- cae.preprocessing.scenario
- data.io.archive
- data.io.file
- 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>assembler_create_systemmodel_from_files</code>. Schema hash: <code>e5e1206bef93</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>