package

tergite_autocalibration.config.package

Classes:

Name	Description
ConfigurationPackage	A package to bundle configuration files.

ConfigurationPackage

ConfigurationPackage()

A package to bundle configuration files. When developing the package itself, please think of the functionality as similar as possible to a .zip archive.

Methods:

Name	Description
copy	Copy a configuration package to another location.
delete	Delete a configuration package.
from_toml	Initialize a configuration package from its configuration.meta.toml file
from_zip	Create a configuration package from a .zip archive.
move	Move a configuration package to another location.

copy

copy(to: str) -> ConfigurationPackage

Copy a configuration package to another location.

Parameters:

Name	Type	Description	Default
to	str	Location to copy the configuration package to	required

Returns:

Type	Description
ConfigurationPackage	An instance of the new copy of ConfigurationPackage

delete

delete()

Delete a configuration package.

Returns:

from_toml staticmethod

from_toml(meta_config_path: str) -> ConfigurationPackage

Initialize a configuration package from its configuration.meta.toml file

Parameters:

Name	Type	Description	Default
meta_config_path	str	Path to the configuration.meta.toml file	required

Returns:

Type	Description
ConfigurationPackage	The initialized ConfigurationPackage

from_zip staticmethod

from_zip(meta_config_zip_path: str) -> ConfigurationPackage

Create a configuration package from a .zip archive. This will unzip the archive and read the configuration.meta.toml file

Parameters:

Name	Type	Description	Default
meta_config_zip_path	str	Path to the .zip archive	required

Returns:

move

move(to: str) -> ConfigurationPackage

Move a configuration package to another location.

Parameters:

Name	Type	Description	Default
to	str	Location to move the configuration package to	required

Returns: