Version:

salvus.project.tools.task_chains.prebuilt_workflows.results.functions

salvus.project.tools.task_chains.prebuilt_workflows.results.functions salvus project tools task_chains prebuilt_workflows results functions
Result functions.

Functions

collect_mesh_results_from_tcc()

Collect mesh chunk results from a task chain controller.
SIGNATURE
def collect_mesh_results_from_tcc(
    tcc: TaskChainController,
) -> dict[str, FailedMeshChunkResult | MeshChunkResult]: ...
ARGUMENTS
Required
tcc
Type:TaskChainController
Description:
The task chain controller.
RETURNS
Return type: dict[str, FailedMeshChunkResult | MeshChunkResult]

collect_results_from_tcc()

This function will collect all results from a finished task chain controller.
SIGNATURE
def collect_results_from_tcc(
    tcc: TaskChainController,
    event_names: list[str],
    all_result_folders: dict[str, dict[str, pathlib.Path]],
    compute_misfit: bool,
    compute_gradients: bool,
) -> dict[
    str, FailedResult | MisfitResult | MisfitAndGradientResult | WaveformResult
]: ...
ARGUMENTS
Required
tcc
Type:TaskChainController
Description:
The task chain controller.
Required
event_names
Type:list[str]
Description:
Names of all events. Also the names of the tasks in the task chain controller.
Required
all_result_folders
Type:dict[str, dict[str, pathlib.Path]]
Description:
Folders where all the results are stored.
Required
compute_misfit
Type:bool
Description:
True if a misfit has been computed.
Required
compute_gradients
Type:bool
Description:
True if gradients have been computed.
PAGE CONTENTS