find_cite.py

Helper function to find all the cite attributes throughout a model.

openmdao.utils.find_cite.find_citations(prob)

Compile a list of citations from all classes in the problem.

Parameters:

prob<Problem>

The Problem instance to be searched.

Returns:

dict

Dict of citations keyed by class.

openmdao.utils.find_cite.print_citations(prob, classes=None, out_stream=DEFAULT_OUT_STREAM)

Write a list of citations from classes in the problem to the given stream.

Parameters:

prob<Problem>

The Problem instance to be searched.

classeslist of str

List of class names for classes to include in the displayed citations.

out_streamfile-like object

Where to send human readable output. Default is sys.stdout. Set to None to suppress.