ramp.User.save

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

Saves/returns the model databas including allappliances 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]

Raises:

Exception – if now appliaces is assigned to the user and the function is called.

Notes

1. 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:

user.save("new_folder/ramp_database")

  1. Appliances are added to the user-type only if ‘windows’ method of the Appliance is called.