CoolProp.BibtexParser module

class CoolProp.BibtexParser.BibTeXerClass(fName=u'../../../CoolPropBibTeXLibrary.bib')

Bases: object

A base class that defines all the variables needed to print a very basic bibliography.

getBibliography(keys=None, fmt='plaintext', style='unsrtalpha', enc=None, objects=False)

This function creates a formatted bibliography according to the defined parameters using Pybtex. Specify your desired output format using the “fmt” parameter. Supported formats are defined by Pybtex and the parameter is only passed on to the plugin search function: latex, html, plaintext and markdown. The “style” parameter is handled similarly. At the moment, Pybtex partly supports the styles: alpha, plain, unsrt and unsrtalpha. Use the objects parameter to obtain the formatted bibliography and the backend renderer instead of the unicode object.

getEntry(key, label=False, fmt='plaintext', style='unsrtalpha', enc=None)

If you only want a single entry from your bibliography and not the whole thing, this function is for you. It uses Pybtex, but removes the prologue and the epilogue and optionally deletes the label. For the other parameters, have a look at getBibliography().

loadLibrary(path, keys=[], encoding='latex')

Open a BibTex file and do some initial parsing. The path to the file has to be provided, otherwise an exception is raised.

Optionally, you can provide an array of keys to reduce the amount of processed entries immediately.

By default, the Bibtex file gets scanned with the artificial “latex” encoding, which translates Latex commands to their unicode equivalents. If you need Latex output, you can skip this step by passing another codec to the “encoding” parameter, for example “ascii” or “utf-8”.

stripCurls(text)

Remove curly brackets from processed Latex code

A function that always returns unicode. It also tries to recurse into lists and dicts, but be careful this is not thoroughly tested.