Site

Site()

The expected variables and data types of attributes of the Site class.

Attributes

name : str: Name of the site.
description : str: Description of the site. Defaults to ““.
lat : float: Latitude of the site.
lon : float: Longitude of the site.
standard_objects : StandardObjectModel, default=StandardObjectModel(): Standard objects of the site.
gui : GuiModel: GUI model of the site.
sfincs : SfincsModel: SFincs model of the site.
fiat : FiatModel: Fiat model of the site.

Name	Description
load_file	Create Site from toml file.
save	Write toml file from model object.

Site.load_file(filepath: Union[str, os.PathLike])

Create Site from toml file.

Site.save(
    filepath: Union[str, os.PathLike],
    sfincs: str = 'sfincs.toml',
    fiat: str = 'fiat.toml',
    gui: str = 'gui.toml',
)

Write toml file from model object.