LegacyProjectIo

class glotaran.builtin.io.folder.folder_plugin.LegacyProjectIo(format_name: str)[source]

Bases: ProjectIoInterface

Project Io plugin to save result data in a backward compatible manner.

Initialize a Project IO plugin with the name of the format.

Parameters:: format_name (str) – Name of the supported format an instance uses.

Methods Summary

`load_model`	Create a Model instance from the specs defined in a file.
`load_parameters`	Create a Parameters instance from the specs defined in a file.
`load_result`	Create a Result instance from the specs defined in a file.
`load_scheme`	Create a Scheme instance from the specs defined in a file.
`save_model`	Save a Model instance to a spec file.
`save_parameters`	Save a Parameters instance to a spec file.
`save_result`	Save the result to a given folder.
`save_scheme`	Save a Scheme instance to a spec file.

Methods Documentation

load_model(file_name: str) → Model

Create a Model instance from the specs defined in a file.

NOT IMPLEMENTED

Parameters:: file_name (str) – File containing the model specs.
Returns:: Model instance created from the file.
Return type:: Model

load_parameters(file_name: str) → Parameters

Create a Parameters instance from the specs defined in a file.

NOT IMPLEMENTED

Parameters:: file_name (str) – File containing the parameter specs.
Returns:: Parameters instance created from the file.
Return type:: Parameters

load_result(result_path: str) → Result

Create a Result instance from the specs defined in a file.

NOT IMPLEMENTED

Parameters:: result_path (str) – Path containing the result data.
Returns:: Result instance created from the file.
Return type:: Result

load_scheme(file_name: str) → Scheme

Create a Scheme instance from the specs defined in a file.

NOT IMPLEMENTED

Parameters:

file_name (str) – File containing the parameter specs.

Returns:

Scheme – Scheme instance created from the file.
.. # noqa (DAR202)
.. # noqa (DAR401)

save_model(model: Model, file_name: str)

Save a Model instance to a spec file.

NOT IMPLEMENTED

Parameters:

model (Model) – Model instance to save to specs file.
file_name (str) – File to write the model specs to.

save_parameters(parameters: Parameters, file_name: str)

Save a Parameters instance to a spec file.

NOT IMPLEMENTED

Parameters:

parameters (Parameters) – Parameters instance to save to specs file.
file_name (str) – File to write the parameter specs to.

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]

Save the result to a given folder.

Warning

Deprecated use glotaran.io.save_result(result, Path(result_path) / 'result.yml') instead.

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

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]

save_scheme(scheme: Scheme, file_name: str)

Save a Scheme instance to a spec file.

NOT IMPLEMENTED

Parameters:

scheme (Scheme) – Scheme instance to save to specs file.
file_name (str) – File to write the scheme specs to.