CsvProjectIo
- class glotaran.builtin.io.pandas.csv.CsvProjectIo(format_name: str)[source]
Bases:
ProjectIoInterface
Plugin for CSV 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.
Load parameters from CSV 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
to a CSV 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
Create a Model instance from the specs defined in a file.
NOT IMPLEMENTED
- load_parameters(file_name: str, sep: str = ',') Parameters [source]
Load parameters from CSV 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: Parameters, file_name: str, *, sep: str = ',', as_optimized: bool = True, replace_infinfinity: bool = True) None [source]
Save a
Parameters
to a CSV file.- Parameters:
parameters (Parameters) – Parameters to be saved to file.
file_name (str) – File to write the parameters to.
sep (str) – Other separators can be used optionally., by default ‘,’
as_optimized (bool) – Weather to include properties which are the result of optimization.
replace_infinfinity (bool) – Weather to replace infinity values with empty strings.
- 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.