YmlProjectIo
- class glotaran.builtin.io.yml.yml.YmlProjectIo(format_name: str)[source]
Bases:
glotaran.io.interface.ProjectIoInterface
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
parse_yaml_file reads the given file and parses its content as YML.
Create a ParameterGroup 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 (NOT IMPLEMENTED).
Save a Model instance to a spec file.
Save a ParameterGroup instance to a spec file (NOT IMPLEMENTED).
Write a
Result
instance to a spec file.Save a Scheme instance to a spec file (NOT IMPLEMENTED).
Methods Documentation
- load_model(file_name: str) glotaran.model.model.Model [source]
parse_yaml_file reads the given file and parses its content as YML.
- load_parameters(file_name: str) glotaran.parameter.parameter_group.ParameterGroup [source]
Create a ParameterGroup instance from the specs defined in a file. :param file_name: File containing the parameter specs. :type file_name: str
- Returns
ParameterGroup instance created from the file.
- Return type
- load_result(result_path: str) glotaran.project.result.Result [source]
Create a
Result
instance from the specs defined in a file.
- load_scheme(file_name: str) glotaran.project.scheme.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: glotaran.model.model.Model, file_name: str)[source]
Save a Model instance to a spec file. :param model: Model instance to save to specs file. :type model: Model :param file_name: File to write the model specs to. :type file_name: str
- save_parameters(parameters: ParameterGroup, file_name: str)
Save a ParameterGroup instance to a spec file (NOT IMPLEMENTED).
- Parameters
parameters (ParameterGroup) – ParameterGroup instance to save to specs file.
file_name (str) – File to write the parameter specs to.
- save_result(result: glotaran.project.result.Result, result_path: str)[source]
Write a
Result
instance to a spec file.