dump#

ams.io.dump(system, output_format, full_path=None, overwrite=None, **kwargs)[source]#

Dump the AMS system data into the requested output format.

Parameters:
system

System object.

output_formatstr

Output format name ('xlsx' or 'json'). As a convenience, None or True is treated as 'xlsx'.

full_pathstr, optional

Full path for the output file. Defaults to <output_path>/<case_name>.<ext>.

overwritebool or None, optional

None (default) prompts interactively when the target exists; True overwrites without prompting; False refuses to overwrite. Matches ams.io.xlsx.write / ams.io.json.write.

**kwargs

Forwarded to the per-format writer. add_book is xlsx-only and is dropped for json.

Returns:
bool

True if successful; False otherwise.