sboxUv2.biblio package

The bibliography of sboxU.

The algorithms implemented in sboxU come from the literature, and this module is how you can find out where they come from—and who you should cite if you use a specific function.

Submodules

sboxUv2.biblio.references module

sboxUv2.biblio.references.cite(key)

Parses bib file shipped with sboxU and returns the bibtex entry corresponding to the given key.

Throws an error if there is no entry with the given key.

sboxUv2.biblio.references.cite_as(key, output_format)

sboxUv2.biblio.references.format_to_rst(entry, key)

sboxUv2.biblio.references.gen_full_biblio_rst(path)

sboxUv2.biblio.references.open_bibliography()

sboxUv2.biblio.references.who_to_cite(sboxU_tool)

Returns a list of strings, each being a bibtex entry citing a paper on which the object sboxU_tool is based.

It works by finding the line “refs: [key0], [key1]…” in the docstring, and parsing it to extract all the keys, i.e. all the substrings of the form “[conf-abbrev:namesYY]”, where “conf-abbrev” is a string containing only letters, “names” is also a string containing only letters, and YY is a sequence of two digits.

Parameters:

sboxU_tool – a function or a module of sboxU. Anything with a docstring in fact.

!WARNING! We need to do something to be able to handle papers which should have identical keys