ramp.UseCase.save

UseCase.save(filename: Optional[str] = None) → Optional[DataFrame]

Saves/returns the model databas including all the users and their appliances as a single pd.DataFrame or excel file.

Parameters:

filename (str, optional) – The path where the data will be stored. if None, function will return a pd.DataFrame, by default None.

Returns:

if filename is passed, returnes None, otherwise will return a pd.DataFrame

Return type:

Union[pd.DataFrame,None]

Notes

The ‘filename’ parameter should consist the path and the name of the file without the file extension. For example, if the user wants to save database into “new_folder” directory and name the file as “ramp_database.xlsx” should use:

usecase.save("new_folder/ramp_database")