Mondaic

salvus.project.tools.task_chains.prebuilt_workflows.results.result_collection

salvus.project.tools.task_chains.prebuilt_workflows.results.result_collection salvus project tools task_chains prebuilt_workflows results result_collection

Result collections.

Classes

ResultCollection

class ResultCollection(builtins.object):
    def __init__(
        self,
        task_chain_controller_run_time: float,
        results_per_event: typing.Mapping[str, _T],
        all_result_folders: dict[str, dict[str, pathlib.Path]],
        compute_misfit: bool,
        compute_gradients: bool,
        timings_per_runner: dict[str, dict[str, float]] = default,
    ) -> None: ...

Result collection for a misfit and/or gradient computation.

Parameters
  • task_chain_controller_run_time float — The run time.
  • results_per_event typing.Mapping[str, _T] — The results for each event.
  • all_result_folders dict[str, dict[str, pathlib.Path]] — The folders where the results are physically located.
  • compute_misfit bool — True if the task chain controller should have computed a misfit.
  • compute_gradients bool — True if the task chain controller should have computed gradients.
  • timings_per_runner dict[str, dict[str, float]] — Additional timings per runner, used to time things like the per-node runner context managers.
Methods
delete_all_files()
def delete_all_files(self) -> None: ...

Delete all files for these results.

Returns None
get_failed_events()
def get_failed_events(self) -> dict[str, FailedResult]: ...

Retrieve all failed events.

Returns dict[str, FailedResult]
get_successfull_events()
def get_successfull_events(
    self,
) -> dict[str, MisfitResult | MisfitAndGradientResult | WaveformResult]: ...

Retrieve the successful events.

Returns dict[str, MisfitResult | MisfitAndGradientResult | WaveformResult]
get_timings_info_strings()
def get_timings_info_strings(self) -> list[str]: ...

Get timing information as a list of strings.

Returns list[str] — A list of strings containing timing information.
list_results()
def list_results(self) -> list[str]: ...

Get a list of all events.

Returns list[str]
print_timings()
def print_timings(self) -> None: ...

Print information about the timer.

Returns None

ResultMeshCollection

class ResultMeshCollection(builtins.object):
    def __init__(
        self,
        task_chain_controller_run_time: float,
        results_per_chunk: typing.Mapping[
            str, MeshChunkResult | FailedMeshChunkResult
        ],
        timings_per_runner: dict[str, dict[str, float]] = default,
    ) -> None: ...

Result collection for the chunked meshing.

Parameters
  • task_chain_controller_run_time float — The run time.
  • results_per_chunk typing.Mapping[str, MeshChunkResult | FailedMeshChunkResult] — The results for each chunk.
  • timings_per_runner dict[str, dict[str, float]] — Additional timings per runner, used to time things like the per-node runner context managers.
Attributes
all_succeeded bool

Return if all succeeded.

Methods
get_timings_info_strings()
def get_timings_info_strings(self) -> list[str]: ...

Get timing information as a list of strings.

Returns list[str] — A list of strings containing timing information.
print_diagnosis()
def print_diagnosis(self) -> None: ...

Log some diagnosis information.

Returns None