hydromt_sfincs.components.config.SfincsConfig.write

SfincsConfig.write(filename: str = 'sfincs.inp', write_description: bool = False, write_comments: bool = False, explicit_only: bool = False) → None

Write the SfincsConfigVariables to a text file in the root folder of the model.

Parameters:

filename (str):

The name of the file to write the configuration to. Default is “sfincs.inp”.

write_description (bool):

If True, append the schema field description as a trailing comment. Default is False.

write_comments (bool):

If True, append the original inline comment read from the source file (if any) as a trailing comment, taking priority over write_description for keys that have one. Default is False.

explicit_only (bool):

If True, write only fields explicitly read or set. Default is False.