.. _auto_simulation_finder:

*RETRIEVES SIMULATIONS BASED ON FILTERS*
========================================

Queries the d3VIEW platform for simulations matching a combination of filters such as keyword search, bookmark status, run status, project, study, and template presence. Use this worker to retrieve a filtered list of simulation records for downstream processing or reporting.

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

Tagged: ``bookmark``, ``filter``, ``project``, ``search``, ``simulation_finder``, ``simulations``, ``status``, ``study``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Search
     - search
     - text
     - —
     - 
     - Free-text keyword string used to search simulation names or metadata; leave null to skip keyword filtering (hidden by default).
   * - Bookmarked
     - bookmarked
     - select
     - —
     - 
     - Filter simulations by bookmark flag; select 'Yes' to return only bookmarked simulations, 'No' for un-bookmarked, or leave blank to return both.
   * - Status
     - status
     - list
     - —
     - 
     - One or more simulation run statuses (e.g., 'completed', 'running', 'failed') fetched from the platform; leave null to return simulations of any status.
   * - Has Template
     - has_template
     - list
     - any
     - 
     - Filter by whether a simulation has an associated response template; choose 'Yes', 'No', or leave at default 'Any' to include all.
   * - Project Name
     - project_name
     - text
     - —
     - 
     - Plain-text name of the project to filter by; used as a loose text match — prefer project_id for exact lookup.
   * - By Project
     - project_id
     - remote_lookup
     - —
     - 
     - One or more project IDs resolved via remote lookup from /api/user/projects; narrows results to simulations belonging to the selected projects.
   * - By Study
     - study_id
     - remote_lookup
     - —
     - 
     - One or more study IDs resolved via remote lookup; depends on project_id being set first, narrows results to simulations within the selected studies.
   * - Colleagues
     - colleagues
     - list
     - —
     - 
     - 
   * - By Workflow
     - workflow_id
     - remote_lookup
     - —
     - 
     - 
   * - Start Date
     - start_date
     - datetime-local
     - —
     - 
     - 
   * - End Date
     - end_date
     - datetime-local
     - —
     - 
     - 
   * - Solver Type
     - solver_type
     - list
     - —
     - 
     - 
   * - Solver Version
     - solver_version
     - list
     - —
     - 
     - 
   * - Solver Termination Type
     - solver_termination_type
     - list
     - —
     - 
     - 
   * - Cores
     - cores
     - list
     - —
     - 
     - 
   * - Shared
     - shared_by
     - list
     - —
     - 
     - 
   * - Shared By User
     - shared_by_user
     - list
     - —
     - 
     - 
   * - Shared With User
     - shared_with_user
     - list
     - —
     - 
     - 
   * - Starts With
     - starts_with
     - text
     - —
     - 
     - 
   * - Starts With Any One
     - starts_with_any_one
     - text
     - —
     - 
     - 
   * - Ends With
     - ends_with
     - text
     - —
     - 
     - 
   * - Ends With Any one
     - ends_with_any_one
     - text
     - —
     - 
     - 
   * - Excludes
     - excludes
     - text
     - —
     - 
     - 
   * - Excludes All
     - excludes_all
     - text
     - —
     - 
     - 
   * - Tags
     - tags
     - list
     - —
     - 
     - 
   * - Has Files by Type
     - has_files_by_type
     - list
     - —
     - 
     - 
   * - Has Files By Name
     - has_files_by_name
     - text
     - —
     - 
     - 
   * - Include File Size
     - file_sizes
     - list
     - —
     - 
     - 
   * - Has Responses By Type
     - has_responses_by_type
     - list
     - —
     - 
     - 
   * - Include Created by Workflows if Project is Selected
     - belonging_to_workflows_in_project
     - list
     - —
     - 
     - 
   * - Has Response By Name
     - response_name
     - text
     - —
     - 
     - 
   * - Min Storage Size
     - storage_used_min
     - text
     - —
     - 
     - 
   * - Max Storage Size
     - storage_used_max
     - text
     - —
     - 
     - 
   * - Solver Primary Hostname
     - solver_primary_hostname
     - list
     - —
     - 
     - 
   * - Limit records
     - limit
     - list
     - 25
     - 
     - 
   * - Sort By
     - order_by
     - list
     - srs.id:desc
     - 
     - 

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - Simulations
     - simulations
     - dataset
     - Dataset of simulation records matching the applied filters, typed as 'simulations'; each record contains simulation metadata (ID, name, status, project, study, template links, etc.) for use by downstream workers.

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

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