.. _auto_simulation_get_bom_graph:

*GET BILL-OF-MATERIAL GRAPH FROM A SIMULATION*
==============================================

Parses the D3HSP file from a completed simulation and extracts its Bill-of-Material (BOM) as a structured graph, capturing part/assembly hierarchy and relationships. Use this worker to inspect component topology or feed downstream graph-based analyses without manually reading D3HSP output.

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

Tagged: ``assembly``, ``bill-of-material``, ``bom``, ``d3hsp``, ``graph``, ``hierarchy``, ``parts``, ``simulation``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Simulation
     - simulation_id
     - remote_lookup
     - —
     - ✓
     - The unique identifier of the target simulation (selected via remote lookup against the simulations catalogue); must point to a completed run whose D3HSP file is available.
   * - Create BOM Graph File
     - create_file
     - boolean
     - False
     - 
     - When true, serialises the extracted BOM graph to a downloadable file in addition to returning the in-memory graph object; defaults to false (no file written).

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - Simulation Id
     - simulation_id
     - scalar
     - Pass-through of the input simulation identifier, enabling downstream workers to reference the same simulation without re-querying.
   * - Bom Graph
     - bom_graph
     - graph
     - Structured graph object representing the full BOM hierarchy extracted from D3HSP, with nodes for parts/assemblies and edges encoding parent-child relationships.
   * - BOM Graph File
     - bom_graph_file
     - file
     - Downloadable file containing the serialised BOM graph; only populated when create_file is set to true, otherwise empty.

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

- cae.postprocessing.extraction
- platform.ontology

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