RAMP Documentation
ramp.ramp_py2xlsx¶
- ramp.ramp_py2xlsx(fname_path, output_path=None, suffix='', keep_names=True)¶
Convert old RAMP python input files to xlsx ones
The old (RAMP version < 0.5) .py input files defined all users and gathered them in a variable named User_list, this variable must be defined in the .py file to be converted to .xlsx.
To convert a .py input file to an .xlsx using the UseCase objects, please refer to https://rampdemand.readthedocs.io/en/latest/examples/using_excel/using_excel.html#exporting-the-database
- Parameters:
fname_path (path) – path to a .py ramp input file containing a variable named User_list
output_path (path, optional) – path to the converted .xlsx ramp input file, by default the same folder as the .py file
suffix (str, optional) – suffix to be added to the converted .xlsx ramp input file name, default ‘’
keep_names (bool, optional) – keep the variable names of the Appliance instances as their ‘name’ attribute, default True