in3Utils.cfgHandling.filterSims

filterSims(avalancheDir, parametersDict, specDir='', simDF='', modName='com1DFA')[source]

Filter simulations using a list of parameters and a pandas dataFrame of simulation configurations if ~ is used as a prefix for a parameter - it is filtered according to values that do NOT match the value provided with the ~Parameter

Parameters

  • avalancheDir (str) – path to avalanche directory

  • parametersDict (dict) – dictionary with parameter and parameter values for filtering

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

  • simDF (pandas DataFrame) – optional - if simDF already available

  • modName (str) – name of computational module used to perform simulations to be filtered

Returns

simNameList – list of simNames that match filtering criteria

Return type

list