.. _auto_simulation_get_folder:

*GET SIMULATION HPC JOB DIRECTORY*
==================================

Looks up a simulation record by ID and returns its HPC job directory path. Use this worker to retrieve the working directory of an already-submitted HPC job before downstream file I/O or post-processing steps.

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

Tagged: ``battery``, ``hpc``, ``hpc_job_dir``, ``job_directory``, ``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 d3VIEW simulation record to query; must reference an existing simulation that has already been submitted to HPC — select via the remote lookup picker (primaryKey: remote_lookup_simulations).

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - Simulation ID
     - simulation_id
     - integer
     - Integer primary key of the resolved simulation record, passed through for use by downstream workers.
   * - HPC Job Directory
     - hpc_job_dir
     - text
     - Absolute filesystem path to the HPC job working directory (e.g. /scratch/jobs/12345); empty string if the simulation has not yet been submitted to HPC.
   * - Status
     - status
     - string
     - Human-readable status message confirming whether hpc_job_dir was found; includes a remediation hint ('Submit the simulation to HPC before calling this worker') when the path is absent.

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

- platform.hpc_config
- platform.job_submission

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