export_config

Configurations.export_config(config_file: str | None = None, overwrite: bool | None = False) → str

Export current design properties to a JSON or TOML file.

The sections to be exported are defined with configuration.options class.

Parameters:

config_filestr, optional

Full path to json file. If None, then the config file will be saved in working directory.

overwritebool, optional

If True the json file will be overwritten if already existing. If False and the version is compatible, the data in the existing file will be updated. Default is False.

Returns:

str

Exported config file.

Examples

>>> from ansys.aedt.core import Hfss
>>> hfss = Hfss()
>>> hfss.configurations.export_config(r"C:\Temp\hfss_config.json", overwrite=True)