save_result

YmlProjectIo.save_result(result: Result, result_path: str, saving_options: SavingOptions = SavingOptions(data_filter=None, data_format='nc', parameter_format='csv', report=True)) → list[str][source]

Write a Result instance to a specification file and data files.

Returns a list with paths of all saved items. The following files are saved if not configured otherwise: * result.md: The result with the model formatted as markdown text. * result.yml: Yaml spec file of the result * model.yml: Model spec file. * scheme.yml: Scheme spec file. * initial_parameters.csv: Initially used parameters. * optimized_parameters.csv: The optimized parameter as csv file. * parameter_history.csv: Parameter changes over the optimization * optimization_history.csv: Parsed table printed by the SciPy optimizer * {dataset_label}.nc: The result data for each dataset as NetCDF file.

Parameters:

  • result (Result) – Result instance to write.

  • result_path (str) – Path to write the result data to.

  • saving_options (SavingOptions) – Options for saving the the result.

Returns:

List of file paths which were created.

Return type:

list[str]