search

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 an explanation how to cite pyMBE #49

Closed davidbbeyer closed 3 months ago

davidbbeyer commented 5 months ago

We currently do not mention our preprint anywhere in the repository except in samples/Beyer2024/README.md, which is a bit hidden. I think it would be a good idea to add a short note on how to cite the project, e.g. in the main README, similar to how it is done for ESPResSo.

pm-blanco commented 5 months ago

I agree, we should add a note in the README. Eventually, we should add a cite funtionality as mentioned in #5, which could provide the user with a list of references that should cite depending on the resources that it has activated in pyMBE, including a citation to our library.