read_pfs

read_pfs(filename, encoding='cp1252', unique_keywords=False)

Read a pfs file to a Pfs object for further analysis/manipulation.

Parameters

Name Type Description Default
filename str | Path | TextIO | dict | PfsSection File name including full path to the pfs file. required
encoding str How is the pfs file encoded? By default ‘cp1252’ 'cp1252'
unique_keywords bool Should the keywords in a section be unique? Some tools e.g. the MIKE Plot Composer allows non-unique keywords. If True: warnings will be issued if non-unique keywords are present and the first occurence will be used by default False False

Returns

Name Type Description
PfsDocument A PfsDocument object