Mondaic
This API reference is not for the latest stable Salvus version.

salvus.project.tools.task_chains.compute_misfits_and_gradients.results.functions

Functions

collect_results_from_tcc()

def collect_results_from_tcc(
    tcc: salvus.flow.sites.task_chain.task_chain_controller.TaskChainController,
    event_names: List[str],
    all_result_folders: List[pathlib.Path],
    compute_gradients: bool,
) -> Dict[
    str,
    Union[
        salvus.project.tools.task_chains.compute_misfits_and_gradients.results.failed_result.FailedResult,
        salvus.project.tools.task_chains.compute_misfits_and_gradients.results.misfit_result.MisfitResult,
        salvus.project.tools.task_chains.compute_misfits_and_gradients.results.misfit_and_gradient_result.MisfitAndGradientResult,
    ],
]:
    ...

This function will collect all results from a finished task chain controller.

Parameters
  • tcc salvus.flow.sites.task_chain.task_chain_controller.TaskChainController — The task chain controller.
  • event_names List[str] — Names of all events. Also the names of the tasks in the task chain controller.
  • all_result_folders List[pathlib.Path] — Folders where all the results are stored.
  • compute_gradients bool — True if gradients have been computed.
Returns Dict[str, Union[salvus.project.tools.task_chains.compute_misfits_and_gradients.results.failed_result.FailedResult, salvus.project.tools.task_chains.compute_misfits_and_gradients.results.misfit_result.MisfitResult, salvus.project.tools.task_chains.compute_misfits_and_gradients.results.misfit_and_gradient_result.MisfitAndGradientResult]]