.. _auto_hpcjobs_finder:

*HPC JOB FINDER*
================

Queries the platform HPC job registry and returns all jobs matching the specified filter criteria (status, solver type, server, user, queue, walltime, cores, host, or simulation). Use this worker to locate and enumerate HPC jobs for downstream monitoring, reporting, or workflow branching.

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

Tagged: ``cores``, ``filter``, ``hpc``, ``hpcjobs``, ``job_finder``, ``queue``, ``simulations``, ``solver``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Job Status
     - status
     - text
     - —
     - 
     - Filter jobs by their current execution status (e.g. 'running', 'completed', 'failed'); leave blank to return jobs of all statuses.
   * - Solver Type
     - solver_type
     - list
     - —
     - 
     - Filter jobs by solver type (e.g. 'LS-DYNA', 'Nastran'); populated via typeahead from the platform job registry — leave blank to include all solver types.
   * - HPCServer
     - hpcserver_id
     - remote_lookup
     - —
     - 
     - Filter jobs by the HPC server on which they were submitted; select from the list of user-accessible HPC servers — leave blank to search across all servers.
   * - User
     - user_id
     - remote_lookup
     - —
     - 
     - Filter jobs by one or more owning users (including yourself); populated from the user directory — leave blank to return jobs for all users.
   * - Job Queue
     - queue
     - list
     - —
     - 
     - Filter jobs by the submission queue name (e.g. 'short', 'long', 'priority'); populated via typeahead — leave blank to include all queues.
   * - Job Walltime
     - job_walltime
     - list
     - —
     - 
     - Filter jobs by their requested walltime value (HH:MM:SS format); populated from existing job records — leave blank to include all walltimes.
   * - Num Cores
     - num_cores
     - list
     - —
     - 
     - Filter jobs by the number of CPU cores requested; populated via typeahead from existing job records — leave blank to include all core counts.
   * - Primary Hostname
     - primary_host
     - list
     - —
     - 
     - Filter jobs by the primary compute node hostname on which they ran; populated via typeahead — leave blank to include all hostnames.
   * - Simulation
     - solverresultset_id
     - remote_lookup
     - —
     - 
     - Filter jobs associated with a specific simulation result set; use the remote lookup to select a simulation — leave blank to search across all simulations.
   * - Project
     - project_id
     - remote_lookup
     - —
     - 
     - 
   * - Study
     - study_id
     - remote_lookup
     - —
     - 
     - 
   * - Start Date
     - date_start
     - datetime-local
     - —
     - 
     - 
   * - End Date
     - date_end
     - datetime-local
     - —
     - 
     - 
   * - Sort
     - order_by
     - list
     - —
     - 
     - 
   * - Sort Order
     - order_type
     - list
     - —
     - 
     - 
   * - Shared
     - shared_by
     - list
     - —
     - 
     - 
   * - Limit
     - limit
     - list
     - —
     - 
     - 
   * - Search
     - search
     - list
     - —
     - 
     - 

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - Hpcjobs
     - hpcjobs
     - dataset
     - Dataset of HPC job records matching all supplied filter criteria; typed as 'hpcjobs' and suitable for downstream monitoring, reporting, or workflow branching steps.

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