vispipe.opt_reader#

vispipe.opt_reader(opt_path, /, filepre='', titlepre='', fill=True, specname=None, dump=False)#

Reader to conver opt files into config dictionaries or json files

Parameters:

  • opt_path (str | PathLike | list[str | PathLike]) – Path or paths to opt files.

  • filepre (str) – A common file prefix for all output files.

  • titlepre (str) – A common title prefix for all plots.

  • fill (bool) – Adds missing datatypes to groups from deflist or settings.json

  • specname (dict | None) – Dictionary used to pass nonstandard file names. Keys are datatypes in the opt file.

  • dump (bool) – Writes config to a json file instead of returning it as a dictionary.

Return type:

dict | None

Returns:

Returns a dictionary to be used by vispipe. If dump is true None is returned.