.. _auto_simulation_create_archive:

*ARCHIVE SIMULATION FILES*
==========================

Packages simulation files from one or more simulations into a single compressed archive (TGZ/ZIP) for distribution or offline storage. Use it when you need to bundle selected simulation attachments—filtered by filename or extension—into a portable archive.

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

Tagged: ``archive``, ``distribution``, ``file_bundling``, ``packaging``, ``simulation``, ``tgz``, ``zip``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Choose Simulations
     - simulation_ids
     - remote_lookup
     - —
     - ✓
     - One or more simulation records whose attached files will be included in the archive; at least one selection is required.
   * - FNTI
     - names
     - text
     - —
     - 
     - Optional comma-separated file-name include filter (FNTI — File Name To Include); leave blank to include all file names.
   * - FETI
     - extensions
     - text
     - —
     - 
     - Optional comma-separated file-extension include filter (FETI — File Extension To Include), e.g. 'csv,d3plot'; leave blank to include all extensions.
   * - File Name
     - file_name
     - text
     - Archive.tgz
     - 
     - Output archive filename including extension (e.g. 'Archive.tgz'); defaults to 'Archive.tgz' when left unchanged.
   * - Choose Specific Files To Include
     - manual_file_name
     - select
     - —
     - 
     - Explicit list of individual simulation attachments to include; overrides name/extension filters when specified, leave empty to rely on filter inputs instead.

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - Archive file
     - archive_file
     - file
     - The resulting compressed archive file (TGZ or ZIP) containing all selected simulation attachments, ready for download or downstream transfer.

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

- data.io.archive
- data.io.file

.. 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_archive</code>. Schema hash: <code>25be2eef31e2</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>