ana3AIMEC.aimecTools.fetchReferenceSimNo

fetchReferenceSimNo(avaDir, inputsDF, comModule, cfg, inputDir='')[source]

Define reference simulation used for aimec analysis.

if the configuration files are available and a varParList is provided, the simulations are ordered and the referenceSimValue is used to define the reference.

otherwise, if a referenceSimName is provided, the reference is based on this name

otherwise, the first file found is used as reference

Parameters

  • avaDir (str) – path to avalanche directory

  • inputsDF (dataFrame) – dataFrame with simulations to analyze and path to result files

  • comModule (str) – computational module used to produce the results to analyze

  • cfg (configParser object) – configuration for aimec - referenceSimValue, varParList used here

  • inputDir (str or pathlib path) – optional- directory where peak files are located, if ‘’, avaDir/Outputs/comMod/peakFiles is set

Returns

  • refSimRowHash (str) – dataframe hash (not simHash) of the simulation used as reference

  • refSimName (str) – name of the simulation used as reference

  • inputsDF (dataFrame) – dataFrame with simulations to analyze and path to result files If com1DFA = comModule and a variation parameter was specified, the com1DFA configuration is merged to the inputsDF

  • colorVariation (boolean) – True if a color variation should be applied in the plots

  • valRef (str) – value of vapParList[0] used to define reference sim