save_result

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

Save the result to a given folder.

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. * 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 * {dataset_label}.nc: The result data for each dataset as NetCDF file.

Note

As a side effect it populates the file path properties of result which can be used in other plugins (e.g. the yml save_result).

Parameters

• result (Result) – Result instance to be saved.

• result_path (str) – The path to the folder in which to save the result.

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

Returns

List of file paths which were created.

Return type

list[str]

Raises

ValueError – If result_path is a file.