Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Typo and question on citing RDTools #414

Closed
matsuobasho opened this issue May 3, 2024 · 2 comments
Closed

Typo and question on citing RDTools #414

matsuobasho opened this issue May 3, 2024 · 2 comments

Comments

@matsuobasho
Copy link

matsuobasho commented May 3, 2024

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
Copy link
Collaborator

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
Copy link
Collaborator

resolved with #421

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants