larch.ModelGroup.to_xlsx

ModelGroup.to_xlsx(filename, save_now=True, data_statistics: bool = True, nesting: bool = True, embed_model: bool = True) → ExcelWriter

Write the estimation results to an Excel file.

Parameters:

• filename (str) – The name of the file to write.

• save_now (bool, default True) – Whether to save the file immediately. If False, the ExcelWriter object is returned.

• data_statistics (bool, default True) – Whether to include data statistics in the Excel file.

• nesting (bool, default True) – Whether to include nesting statistics in the Excel file.

• embed_model (bool, default True) – Whether to embed the model in the Excel file.

Returns:

larch.util.excel.ExcelWriter or None