ExcelProjectIo
- class glotaran.builtin.io.pandas.xlsx.ExcelProjectIo(format_name: str)[source]
Bases:
glotaran.io.interface.ProjectIoInterface
Plugin for Excel like data io.
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 (NOT IMPLEMENTED).
Load parameters from XLSX file.
Create a Result instance from the specs defined in a file (NOT IMPLEMENTED).
Create a Scheme instance from the specs defined in a file (NOT IMPLEMENTED).
Save a Model instance to a spec file (NOT IMPLEMENTED).
Save a
ParameterGroup
to a Excel file.Save a Result instance to a spec file (NOT IMPLEMENTED).
Save a Scheme instance to a spec file (NOT IMPLEMENTED).
Methods Documentation
- load_model(file_name: str) Model
Create a Model instance from the specs defined in a file (NOT IMPLEMENTED).
- load_parameters(file_name: str) glotaran.parameter.parameter_group.ParameterGroup [source]
Load parameters from XLSX file.
- load_result(result_path: str) Result
Create a Result instance from the specs defined in a file (NOT IMPLEMENTED).
- 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_parameters(parameters: glotaran.parameter.parameter_group.ParameterGroup, file_name: str, *, as_optimized: bool = True)[source]
Save a
ParameterGroup
to a Excel file.- Parameters
parameters (ParameterGroup) – Parameters to be saved to file.
file_name (str) – File to write the parameters to.
as_optimized (bool) – Whether to include properties which are the result of optimization.
- 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 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.