.. _auto_simulations_create_from_archive_file:

*CREATE SIMULATIONS FROM ARCHIVE_FILE*
======================================

Unpacks a compressed archive file (.zip, .7z, .tar, .tgz, .gz) and registers one or more simulations on the d3VIEW platform, optionally grouping them into a named study. Use this worker to bulk-ingest simulation runs distributed as archive packages into the platform's simulation registry.

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

Tagged: ``7z``, ``archive``, ``bulk_import``, ``ingest``, ``lsdyna``, ``simulation_import``, ``study``, ``tar``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Archive File
     - archive_file
     - file
     - —
     - ✓
     - Compressed archive containing the simulation files to import; accepted formats are .zip, .7z, .tar, .tgz, and .gz — this is the only required input.
   * - Solver Type
     - solver_type
     - string
     - lsdyna
     - 
     - Solver associated with the imported simulations (e.g. 'lsdyna'); defaults to 'lsdyna' and can be left unchanged for LS-DYNA decks.
   * - Main Input Tokens
     - main_input_tokens
     - string
     - main,Main,master,DynaOpt
     - 
     - Comma-separated filename substrings (e.g. 'main,Main,master,DynaOpt') used to identify the primary input file within each simulation directory; leave at default for standard LS-DYNA naming conventions.
   * - Input File Tokens
     - include_file_tokens
     - string
     - key,k,inc,dyn,response,.xy,gif,png,mov,mp4,csv,history,XPoint
     - 
     - Comma-separated filename extensions or substrings (e.g. 'key,k,inc,dyn,csv,png') that determine which files inside the archive are attached to each simulation; extend the default list only when non-standard file types must be included.
   * - Study Name
     - study_name
     - string
     - Simulations from Archive
     - 
     - Human-readable label for the study that groups all imported simulations together; defaults to 'Simulations from Archive' and can be customized to reflect the campaign or test series name.
   * - Directory Tokens
     - dir_tokens
     - string
     - /([0-9]+).([0-9])+/
     - 
     - Regex pattern (default '/([0-9]+).([0-9])+/') used to identify subdirectories inside the archive that each correspond to an individual simulation run; adjust when directories follow a non-numeric naming scheme.
   * - Archive Type
     - archive_type
     - string
     - generic
     - 
     - Layout convention of the archive (e.g. 'generic'); defaults to 'generic' and should only be changed when the archive follows a vendor-specific or pre-defined folder structure.
   * - Simulation Name Prefix
     - sim_prefix
     - string
     - —
     - 
     - Optional string prepended to every generated simulation name, useful for distinguishing runs across multiple import batches; leave blank if no prefix is needed.

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - Simulations
     - simulations
     - dataset
     - Dataset of simulation records (dataType: simulation) created on the platform, one entry per detected run directory within the archive.
   * - Study
     - study
     - integer
     - Integer ID of the platform study object that groups all newly created simulations under the provided study name.

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

- data.dataset.ingest
- data.io.archive
- 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>simulations_create_from_archive_file</code>. Schema hash: <code>77a8f87d997b</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>