ProjectIoInterface
- class glotaran.io.interface.ProjectIoInterface(format_name: str)[source]
Bases:
object
Baseclass for Project IO plugins.
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
Create a Model instance from the specs defined in a file.
Create a Parameters instance from the specs defined in a file.
Create a Result instance from the specs defined in a file.
Create a Scheme instance from the specs defined in a file.
Save a Model instance to a spec file.
Save a Parameters instance to a spec file.
Save a Result instance to a spec file.
Save a Scheme instance to a spec file.
Methods Documentation
- load_model(file_name: str) Model [source]
Create a Model instance from the specs defined in a file.
NOT IMPLEMENTED
- load_parameters(file_name: str) Parameters [source]
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:
- load_result(result_path: str) Result [source]
Create a Result instance from the specs defined in a file.
NOT IMPLEMENTED
- load_scheme(file_name: str) Scheme [source]
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)[source]
Save a Model instance to a spec file.
NOT IMPLEMENTED
- save_parameters(parameters: Parameters, file_name: str)[source]
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 a Result instance to a spec file.
NOT IMPLEMENTED
- Parameters:
result (Result) – Result instance to save to specs file.
result_path (str) – Path to write the result data to.
saving_options (SavingOptions) – Options for the saved result.