Mondaic DocumentationRequired
task_chain_controller_run_time| Type: | float |
| Description: | The run time. |
Version:
2026.5.0
Salvus documentation version
2026.5.0
2025.1.3
2024.1.3
0.12.16
No results found.
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_collectionResult collections.
Classes
ResultCollection
Result collection for a misfit and/or gradient computation.
SIGNATURE
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: ...ARGUMENTS
Required
results_per_event| Type: | typing.Mapping[str, _T] |
| Description: | The results for each event. |
Required
all_result_folders| Type: | dict[str, dict[str, pathlib.Path]] |
| Description: | The folders where the results are physically located. |
Required
compute_misfit| Type: | bool |
| Description: | True if the task chain controller should have computed a misfit. |
Required
compute_gradients| Type: | bool |
| Description: | True if the task chain controller should have computed gradients. |
Optional
timings_per_runner| Type: | dict[str, dict[str, float]] |
| Default value: | <factory> |
| Description: | Additional timings per runner, used to time things like the per-node runner context managers. |
Methods
ResultCollection.delete_all_files()
Delete all files for these results.
SIGNATURE
def delete_all_files(self) -> None: ...ResultCollection.get_failed_events()
Retrieve all failed events.
SIGNATURE
def get_failed_events(self) -> dict[str, FailedResult]: ...ResultCollection.get_successfull_events()
Retrieve the successful events.
SIGNATURE
def get_successfull_events(
self,
) -> dict[str, MisfitResult | MisfitAndGradientResult | WaveformResult]: ...ResultCollection.get_timings_info_strings()
Get timing information as a list of strings.
SIGNATURE
def get_timings_info_strings(self) -> list[str]: ...ResultCollection.list_results()
Get a list of all events.
SIGNATURE
def list_results(self) -> list[str]: ...ResultCollection.print_timings()
Print information about the timer.
SIGNATURE
def print_timings(self) -> None: ...ResultMeshCollection
Result collection for the chunked meshing.
SIGNATURE
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: ...ARGUMENTS
Required
task_chain_controller_run_time| Type: | float |
| Description: | The run time. |
Required
results_per_chunk| Type: | typing.Mapping[str, MeshChunkResult | FailedMeshChunkResult] |
| Description: | The results for each chunk. |
Optional
timings_per_runner| Type: | dict[str, dict[str, float]] |
| Default value: | <factory> |
| Description: | Additional timings per runner, used to time things like the per-node runner context managers. |
Properties
- all_succeeded(
bool)-Return if all succeeded.
Methods
ResultMeshCollection.get_timings_info_strings()
Get timing information as a list of strings.
SIGNATURE
def get_timings_info_strings(self) -> list[str]: ...ResultMeshCollection.print_diagnosis()
Log some diagnosis information.
SIGNATURE
def print_diagnosis(self) -> None: ...
We use cookies to analyze our traffic, but won't track you until explicit consent is given. Using our contact form will create relevant cookies and transmit data to third party services to keep track of your request. Read more about how we use personal information in our Privacy Policy.
PAGE CONTENTS