pyhf.utils.citation

pyhf.utils.citation(oneline=False)

Get the bibtex citation for pyhf

Example

>>> import pyhf
>>> pyhf.utils.citation(oneline=True)
'@software{pyhf,  author = {Lukas Heinrich and Matthew Feickert and Giordon Stark},  title = "{pyhf: v0.7.6}",  version = {0.7.6},  doi = {10.5281/zenodo.1169739},  url = {https://doi.org/10.5281/zenodo.1169739},  note = {https://github.com/scikit-hep/pyhf/releases/tag/v0.7.6}}@article{pyhf_joss,  doi = {10.21105/joss.02823},  url = {https://doi.org/10.21105/joss.02823},  year = {2021},  publisher = {The Open Journal},  volume = {6},  number = {58},  pages = {2823},  author = {Lukas Heinrich and Matthew Feickert and Giordon Stark and Kyle Cranmer},  title = {pyhf: pure-Python implementation of HistFactory statistical models},  journal = {Journal of Open Source Software}}'

Keyword Arguments:

oneline (bool) – Whether to provide citation with new lines (default) or as a one-liner.

Returns:

The citation for this software

Return type:

citation (str)