TaskResult

class ase2sprkkr.outputs.task_result.TaskResult(input_parameters, calculator, directory, output_file=None, input_file=None, task_name=None)[source]

A base class for a result of a runned task (kkrscf executable)

Class hierarchy

Inheritance diagram of ase2sprkkr.outputs.task_result.TaskResult


Constructor

__init__(input_parameters, calculator, directory, output_file=None, input_file=None, task_name=None)[source]
produces_potential = False

Whether this result produces a new potential usable by later tasks.

sfn_generated = None

Whether this calculation generated rather than reused its SFN file.

property directory[source]
path_to(file)[source]

return full path to a given file

..doctest:: >>> t = TaskResult(None, None, “/example”) >>> t.files.add_file(“input”, “input.txt”) <Option input of type String with value = input.txt> >>> t.path_to(“input”) ‘/example/input.txt’

property task_name
property input_parameters[source]
_candidate_input_files()[source]

Use an unambiguous native input file; never guess between runs.

property input_parameters_file[source]
property potential_filename[source]

New (output) potential file name

property potential[source]

The new (output) potential - that contains the converged charge density etc.

property any_potential

Return the parsed potential (SCF then try output and then input)

parse_result_file(file, potential=None)[source]

Parse a registered structured result file in this calculation context.

new_task(task)[source]

Create a fresh calculator for task using values from this result.

complete(error, return_code)[source]
enrich_declared_output_files(*, warn_missing=True)[source]

Expose existing task-declared outputs, preserving parsed FILES entries.

property atoms
property output_values

Files and other values exposed as the public result summary.

_ordered_output_files()[source]

Put actual result files first; omit internal, untyped task caches.

to_file_manifest(*, output_path=None, potential_path=None, result_files=None, output_version=None)[source]

Capture the files used or produced by this result as a KKRunner manifest.

classmethod from_file(file)[source]

Read a standalone SPR-KKR output using registry-owned detection.

classmethod from_run(run, manager=None)[source]

Load a persisted run using an execution manager.

With no manager, use the shared default project-run store. The manager retrieves missing files and checks their saved fingerprints.

classmethod from_run_record(record, *, output_file=None, error_file=None, return_code=None)[source]

Parse a locally available run using its persisted task metadata.

File retrieval and fingerprint verification are handled by from_run() through the project run manager, not by this method.