.. _auto_binout_summary:

*BINOUT SUMMARY EXTRACTOR*
==========================

Reads one or more LS-DYNA binout files (from a simulation record or direct upload) and returns a structured dataset summarising the available time-history branches, their IDs, labels, components, and optional min/max final values. Use this worker to quickly inventory what data is stored in a binout before running targeted extraction steps.

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

Tagged: ``binout``, ``binout2xml``, ``branch``, ``d3hsp``, ``extraction``, ``ls-dyna``, ``summary``, ``time-history``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Simulation
     - simulation_id
     - remote_lookup
     - —
     - ✓
     - One or more simulation records (remote lookup against the simulations data-type) whose source directory contains the binout files to summarise; required when no direct files are uploaded.
   * - Summary Type
     - summary_type
     - select
     - quick_summary
     - 
     - Controls the verbosity of the summary: 'quick_summary' (default) lists branches only; 'full_summary' appends min/max of final values; 'quick_summary_with_ids_labels' adds entity IDs and labels; 'quick_summary_with_ids_labels_and_components' further adds component names.
   * - Branch Types
     - branch_types
     - text
     - —
     - 
     - Optional comma-separated list of binout branch/file names (e.g. 'nodout,elout') to restrict the output to; leave blank to return all branches found in the binout.

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - binout_summary
     - binout_summary
     - dataset
     - Dataset (JSON array of objects) where each row describes one binout branch — including file_name, available IDs/labels/components, and min/max values depending on the chosen summary_type.

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

- cae.postprocessing.extraction

.. raw:: html

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