optimizer_file_reader

A module containing the reader for PQ optimizer output files.

Summary

Classes:

OptimizerFileReader

A reader for the fixed 13-column .opt files written by PQ.

Functions:

read_optimizer_file

Read a PQ optimizer output file.

Reference

class OptimizerFileReader(filename: str)

Bases: BaseReader

A reader for the fixed 13-column .opt files written by PQ.

Parameters:

filename (str) – The optimizer output file to read.

read() → Energy

Read the optimizer output and return its values with the PQ schema.

Returns:

Optimizer values arranged as parameters by optimization steps.

Return type:

Energy

Raises:

OptimizerReaderError – If the file is empty or contains an invalid row.

logger = <CustomLogger PQAnalysis.OptimizerFileReader (INFO)>

read_optimizer_file(

filename: str,

) → Energy

Read a PQ optimizer output file.

Parameters:

filename (str) – The optimizer output file to read.

Returns:

Optimizer values arranged as parameters by optimization steps.

Return type:

Energy