in3Utils.cfgHandling.orderSimFiles

orderSimFiles(avalancheDir, inputDir, varParList, ascendingOrder, specDir='', resFiles=False)[source]

Filter simulations results using a list of parameters and a flag if in ascending or descending order

Parameters
  • avalancheDir (str) – path to avalanche directory

  • inputDir (str) – path to simulation results

  • varParList (str or list) – simulation configuration parameters for ordering simulations

  • ascendingOrder (bool) – True if simulations shall be ordered in ascending order regarding varPar

  • specDir (str) – path to a directory where simulation configuration files can be found - optional

Returns

dataDF – dataFrame of simulation results (fileName, … and values for parameters in varParList)

Return type

pandas dataFrame