Skip to content

Plot

plot

Plot workflow action.

Generates a publication-ready chart from a summarise CSV output or a metrics workflow cache. The action writes no cache, so it runs once. The action is stateless, so validation and execution delegate to module-level helpers and each step stays within the module and method limits.

Classes:

  • PlotAction –

    Generate a chart from a summarise CSV output.

PlotAction

Generate a chart from a summarise CSV output.

Attributes:

  • action_name –

    Action name as used in workflow definitions.

  • pattern –

    Workflow action pattern used for cache validation.

Methods:

  • run –

    Execute chart generation from a summarise CSV output.

  • validate –

    Validate plot parameters before execution.

run
run(
    parameters: Dict[str, Any],
    mode: str,
    context: Optional[Any] = None,
    logger: Optional[Any] = None,
) -> ActionResult

Execute chart generation from a summarise CSV output.

Reads the input CSV, builds the long-form data required by the legacy plotting functions and writes the output chart file.

Parameters:

  • parameters
    (Dict[str, Any]) –

    Action parameter values.

  • mode
    (str) –

    Execution mode ('dry-run', 'run' or 'compare').

  • context
    (Optional[Any], default: None ) –

    Workflow context for optimisation.

  • logger
    (Optional[Any], default: None ) –

    Logger for reporting.

Returns:

  • ActionResult –

    Tuple of (status, metadata, objects).

Raises:

  • ActionExecutionError –

    If execution fails.

validate
validate(parameters: Dict[str, Any]) -> None

Validate plot parameters before execution.

Parameters:

  • parameters
    (Dict[str, Any]) –

    Action parameter values.

Raises:

  • ValueError –

    If a parameter is missing or invalid. The provider converts this to an ActionValidationError.