grapa.scripts.script_correlations.process_file

grapa.scripts.script_correlations.process_file(filename: str, datakeys: str | List[str] = 'AUTO', filters: list | None = None, idx_pattern=None, idx_labels=None, newGraphKwargs: dict | None = None, figure_factory: MplFigureFactory | None = None) → Graph

Process a file contaiing correleation data. e.g. a SCAPS output file of a 2-parameter sweep. Creates different graph files and images in the same folder, and returns one of the graphs.

Parameters:

• filename – file to process

• datakeys –

  how to interpret the file content.

  • CONF.AS_DATATABLE: open the file as a datatable

  • CONF.AS_SCAPS: assumes this is the output of Scaps simulations. also preselect series of interest

  • CONF.AUTO: first open the graph, then auto detect

  • [key1, key2, …]: to retrieve from graph Graph, each Curve is one

    ”experiment”

• filters – list of conditions to exclude specific “experiments” (e.g. rows in a table) should be excluded. e.g. [[“Jsc_mApcm2”, HIGHER, 10]]

• idx_pattern – list/range of data to consider for the correlation plots By default, whow all columns

• idx_labels – list/range of data to consider for the correlation plots By default, whow all columns

• newGraphKwargs – specific to Grapa, to e.g. have consistent config file

Returns:

a Graph object