pyMBE-dev / pyMBE

pyMBE provides tools to facilitate building up molecules with complex architectures in the Molecular Dynamics software ESPResSo. For an up-to-date API documention please check our website:
https://pymbe-dev.github.io/pyMBE/pyMBE.html
GNU General Public License v3.0
6 stars 8 forks source link

Add feature for citing resources in pyMBE #54

Open pm-blanco opened 5 months ago

pm-blanco commented 5 months ago

Migrated from #5 for clarity, original idea by @jngrad

Our resources now include "qualified references", i.e. unique identifiers that can be queried in dedicated resolvers, including a "citekey" metadata field that can be resolved against the BibTeX file in the refs/ folder, just like ESPResSo does with doc/bibliography.bib. We could introduce a function pyMBE.pymbe_cite() to print to the terminal the BibTeX record of pyMBE and the BibTeX record of the pKa set that was used, or use a Sphinx plugin to run LaTeX in the background and print the formatted citations in a specific citation style. This is standard practice in the R ecosystem [^citation-r-ecosystem], and is very slowly coming into the Python ecosystem [^citation-py-ecosystem].

[^citation-r-ecosystem]: LaZerte 2021, "How to Cite R and R Packages", rOpenSci: https://ropensci.org/blog/2021/11/16/how-to-cite-r-and-r-packages/#how-to-cite-r-packages [^citation-py-ecosystem]: Python package citepy 0.5.0: https://pypi.org/project/citepy/