mario.Database.get_shock_excel

Database.get_shock_excel(path=None, num_shock=10, **clusters)
Creates an Excel file based on the shape and the format

of the database for the shock impelemntation.

Note

The generated Excel file will have list validations to simplify the error handling and help the user. In case the number of shocks are more than 10, it is suggested to increse num_shock to have more validated rows in every sheet of the Excel file.

Parameters:
  • path (str) – defines the path which the Excel file will be stored

  • clusters (dict) – nested dictwith clusters the user can define a sets of clusters for more specificed shock implementation. e.g. clusters = {‘Region’:{‘cluster_1’:[‘reg1’,’reg2’]}}