search

NREL / rdtools

PV Analysis Tools in Python
https://rdtools.readthedocs.io/
MIT License
153 stars 65 forks source link

Typo and question on citing RDTools #414

Closed matsuobasho closed 1 month ago

matsuobasho commented 5 months ago

Describe the bug The citing RDtools section in Readthedocs has a typo:

Michael G. Deceglie, Ambarish Nag, Adam Shinn, Gregory Kimball, Daniel Ruth, Dirk Jordan, Jiyang Yan, Kevin Anderson, Kirsten Perry, Mark Mikofski, Matthew Muller, Will Vining, and Chris Deline RdTools, version {insert version}, Compuer Software, https://github.com/NREL/rdtools. DOI:{insert DOI}

Should be Computer Software

Additional context Also, there is no period between Chris Deline and RDtools. Additionally, what is the difference between the version number and the DOI?

mdeceglie commented 3 months ago

Thanks for catching those typos, we'll get that updated.

The DOI is a digital object identifier that you can get from the project's zenodo page. It provides a static archival link to the files corresponding to a specific version. The version number is just from the RdTools versioning system. For example, to cite version 3.0.0-alpha.4 you would use:

Michael G. Deceglie, Ambarish Nag, Adam Shinn, Gregory Kimball, Daniel Ruth, Dirk Jordan, Jiyang Yan, Kevin Anderson, Kirsten Perry, Mark Mikofski, Matthew Muller, Will Vining, and Chris Deline. RdTools, Version 3.0.0-alpha.4, Computer Software, https://github.com/NREL/rdtools. DOI: 10.5281/zenodo.10247179

martin-springer commented 1 month ago

resolved with #421