iphasimulator.workflows.hpc
===========================

.. py:module:: iphasimulator.workflows.hpc

.. autoapi-nested-parse::

   Config-driven workflow helpers for scripted and HPC runs.



Attributes
----------

.. autoapisummary::

   iphasimulator.workflows.hpc.DEFAULT_WORKFLOW_CONFIG


Functions
---------

.. autoapisummary::

   iphasimulator.workflows.hpc.load_workflow_config
   iphasimulator.workflows.hpc.targets_from_config
   iphasimulator.workflows.hpc.target_stage_name
   iphasimulator.workflows.hpc.workflow_plan
   iphasimulator.workflows.hpc.render_slurm_script


Module Contents
---------------

.. py:data:: DEFAULT_WORKFLOW_CONFIG
   :type:  dict[str, Any]

.. py:function:: load_workflow_config(path: str | pathlib.Path) -> dict[str, Any]

   Load a YAML workflow config and apply defaults.


.. py:function:: targets_from_config(config: dict[str, Any]) -> tuple[iphasimulator.workflows.validation.ValidationTarget, ...]

   Parse validation targets from workflow config.


.. py:function:: target_stage_name(target: iphasimulator.workflows.validation.ValidationTarget) -> str

   Return the short target name used for MD output directories.


.. py:function:: workflow_plan(config: dict[str, Any]) -> list[str]

   Return human-readable planned workflow actions.


.. py:function:: render_slurm_script(*, config_path: str | pathlib.Path, repo_root: str | pathlib.Path = '.', config: dict[str, Any] | None = None) -> str

   Render a SLURM submission script for a configured workflow.