Report Registry

This submodule contains the report_registry that’s used for generating Iteration Progress Reports. It also contains the functions that come pre-enrolled in the report_registry for calculating traceable quantities.

Please see the documentation on Iteration Progress Reports for more information, including how to use the registry.

Accessing the Report Registry

pydmqmc.report_registry = <pydmqmc.report.registry._ReportRegistry object>

Class for associating functions and their dependencies with a string.

pydmqmc.report_registry.list_requirements(name)	List a function's requirements.
pydmqmc.report_registry.get_requirements(...)	Check for a function's requirements in a given Method.
pydmqmc.report_registry.enroll(name, ...)	Include a new analysis function in the registry.
pydmqmc.report_registry.keys()	Return a view of the registry's enrolled function keys.
pydmqmc.report_registry.functions
pydmqmc.report_registry.requirements

Functions for Standard Quantities

These functions are already enrolled in the report_registry for use as detailed in the page on Iteration Progress Reports.

pydmqmc.report.trace(matrix)	Calculate the trace of a given matrix.
pydmqmc.report.energy_numerator(matrix, ...)	Numerator of the energy estimator.
pydmqmc.report.energy_expectation(matrix, ...)	Return the expectation value of the energy estimator.
pydmqmc.report.von_neumann_numerator(matrix)	Numerator of the von Neumann estimator.
pydmqmc.report.von_neumann_expectation(matrix)	Return the expectation value of the von Neumann estimator.