pyiron_base.state.publications module

Wouldn’t it be nice to automate your bibliography? Well we can’t, but that’s the idea behind this alpha-stage feature. The idea is that various pyiron submodules and objects will register their relevant publications and you can just ask your project for a list of everything you should cite. Publications is the way we work towards this goal.

class pyiron_base.state.publications.Publications(*args, **kwargs)

Bases: object

add(pub_dict: Dict) → None

Add a publication to the list of publications.

Parameters:

pub_dict (dict) – The key should be the name of the code used and the value a list of publications to cite.

list() → List[Dict]

List of publications currently in use.

Returns:

list of publications

Return type:

list

property pyiron_publication: Dict

reset() → None

Clean the publication list back to the default pyiron publication.

show(bib_format: Literal['pandas', 'dict', 'bibtex', 'apa'] = 'pandas') → Dict | DataFrame | str

List the publications used in this project.

Parameters:

bib_format ('pandas'|'dict'|'bibtex'|'apa') – Which format to use. Pandas (dataframe) and dict return the corresponding python object, while bibtex and apa give formatted strings.

Returns:

Publication data.

Return type:

pandas.DataFrame|dict|str