Control Analysis

Extract and filter parsed control-parameter sections as analyzer outputs.

This module exposes analyzer tasks over parsed control configuration blocks, including section-level selection and key/value filtering for reporting. It is intentionally limited to control-parameter content and does not read raw files directly.

Usage context

• Input auditing: Inspect effective control settings used for a run.
• Section-level review: Pull only general, md, mm, ff, or outdated.
• Reproducibility logs: Export normalized control tables for reports.

Request: ControlParametersTaskRequest

Request for extracting a control parameter as a table row.

Fields

Field	Type	Default	Help	Choices
key	str		Control key to retrieve (case-insensitive). Examples: 'nmdit', 'iout2', 'imetho'.
section	Optional[str]		Optional control section to search. If omitted, all sections are searched in default order. Example: 'md'.	general, md, mm, ff, outdated

Examples

req = ControlParametersTaskRequest(key="nmdit", section="md")

Sample output: ControlParametersTaskRequest(...) Meaning: The request asks for one control key lookup in a selected section.

Result: ControlParametersTaskResult

Result for a control-parameter table extraction.

Fields

Field	Type	Default	Help	Choices
table	pd.DataFrame
request	ControlParametersTaskRequest

Examples

result = ControlParametersTask().run(data, req)
result.table

Sample output: One-row DataFrame (for example: key='iout2', value=20, section='md', found=True). Meaning: The result captures resolved value and provenance for one key lookup.

Task: ControlParametersTask

Return one control parameter as a one-row table.

Method: recommended_presentations(_result: ControlParametersTaskResult, _payload: dict[str, Any])

Return default table presentation for control lookup outputs.

Works on

Analyzer task output payloads

Parameters

Name	Type	Description
_result	ControlParametersTaskResult	Analysis result object for the executed task.
_payload	dict[str, Any]	Serialized result payload.

Returns

Type	Description
list[PresentationSpec]	Table presentation specification.

Examples

specs = ControlParametersTask.recommended_presentations(result, payload)

Sample output: [PresentationSpec(renderer="table", ...)] Meaning: Control lookup outputs default to tabular rendering.

Method: run(data: ControlParametersData, request: ControlParametersTaskRequest, reporter=None)

Resolve one control key and return a one-row result table.

Works on

ControlParametersData plus ControlParametersTaskRequest inputs

Parameters

Name	Type	Description
data	ControlParametersData	Parsed control-parameter sections.
request	ControlParametersTaskRequest	Key/section lookup configuration.
reporter	Any, optional	Unused progress callback parameter for task API compatibility.

Returns

Type	Description
ControlParametersTaskResult	One-row lookup result with value, section, and found flag.

Examples

result = ControlParametersTask().run(data, ControlParametersTaskRequest(key="iout2"))

Sample output: result.table with columns key, value, section, found. Meaning: A single control entry is normalized into table form.