.. _auto_study_get_info:

*RETRIEVES STUDY INFORMATION*
=============================

Retrieves metadata and parameter tables for a specified d3VIEW study. Returns study-level info, per-simulation details, physical test records, and DOE parameter sets. Use this worker to feed downstream analysis or reporting steps that need structured study context.

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

Tagged: ``battery``, ``doe_parameters``, ``metadata``, ``platform``, ``remote_lookup``, ``simulation_info``, ``study``, ``study_info``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Study
     - study_id
     - remote_lookup
     - —
     - ✓
     - The d3VIEW study to query; resolved via remote lookup against the studies registry — required, must map to a valid study primary key.
   * - Simulations
     - simulatiosn
     - dataset
     - —
     - 
     - Optional dataset of simulation records used to restrict all output tables to a specific subset of simulations within the study; leave empty to return data for all simulations.

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - Study Id
     - study_id
     - integer
     - Integer primary key of the queried study as stored in the d3VIEW studies table; useful for chaining into other platform workers that require a study ID.
   * - Info
     - info
     - dataset
     - Dataset containing top-level study metadata (name, owner, creation date, status, description, and other study-level attributes).
   * - Sim Info
     - sim_info
     - dataset
     - Dataset with one row per simulation belonging to the study (or per the filtered subset), including simulation IDs, names, statuses, and run parameters.
   * - Test Info
     - test_info
     - dataset
     - Dataset listing physical test records associated with the study, including test IDs, labels, and relevant test metadata for sim-vs-test correlation workflows.
   * - Doe Parameters
     - doe_parameters
     - dataset
     - Dataset of DOE design variables and their values for each simulation in the study; empty if no DOE parameterization is defined for the study.

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

- data.dataset.ingest
- design_exploration.doe
- 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>study_get_info</code>. Schema hash: <code>9560b6e58895</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>