export_scenario() function

Export all related entities of a scenario to an archive zip file.

This function exports all related entities of the specified scenario to the specified archive zip file.

Parameters:

Name	Type	Description	Default
scenario_id	ScenarioId	The ID of the scenario to export.	required
output_path	Union[str, Path]	The path to export the scenario to. The path should include the file name without the extension or with the .zip extension. If the path exists and the override parameter is False, an exception is raised.	required
override	bool	If True, the existing folder will be overridden. The default value is False.	False
include_data	bool	If True, the file-based data nodes are exported as well. This includes Pickle, CSV, Excel, Parquet, and JSON data nodes. If the scenario has a data node that is not file-based, a warning will be logged, and the data node will not be exported. The default value is False.	False

Raises:

Type	Description
ExportPathAlreadyExists	If the output_path already exists and the override parameter is False.