project_io_registration

Project Io registration convenience functions.

Note

The [call-arg] type error would be raised since the base methods doesn’t have a **kwargs argument, but we rather ignore this error here, than adding **kwargs to the base method and causing an [override] type error in the plugins implementation.

Functions

Summary

get_project_io	Retrieve a data io plugin from the project_io registry.
get_project_io_method	Retrieve implementation of project io functionality for the format 'format_name'.
is_known_project_format	Check if a data format is in the project_io registry.
known_project_formats	Names of the registered project io plugins.
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.
project_io_plugin_table	Return registered project io plugins and which functions they support as markdown table.
register_project_io	Register project io plugins to one or more formats.
save_model	Save a Model instance to a spec file.
save_parameters	Save a Parameters instance to a spec file.
save_result	Write a Result instance to a spec file.
save_scheme	Save a Scheme instance to a spec file.
set_project_plugin	Set the plugin used for a specific project format.
show_project_io_method_help	Show help for the implementation of project io plugin methods.
supported_file_extensions_project_io	Get project io formats that support all methods in method_names.