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

Citations seem out of date #68

Open
simmsa opened this issue May 16, 2024 · 3 comments
Open

Citations seem out of date #68

simmsa opened this issue May 16, 2024 · 3 comments

Comments

@simmsa
Copy link
Contributor

simmsa commented May 16, 2024

The Cite Us page in the documentation seems out of date.

  • Authors:
    • Does it make sense to update the authors to the current contributors of each package?
  • Abstract Note:
    • References to Code Hub should be changed to Software
  • Year
    • How should this be handled? Technically 2020 was the year of inception, but the software has changed significantly between 2020 and the present.
@akeeste
Copy link
Contributor

akeeste commented May 17, 2024

I agree, the current citation is pretty dated. We should check what current best practices are for software citation. A few routes we can go based on other projects I work on:

  • Create a new DOI for each release through Zenodo. Ask users to cite the DOI of the version of MHKiT that they use. This gives an very long list of contributors in order of GitHub stats (commits?). There's no other information tied to the DOI, just the software release.
  • Change the citation to a new publication (conference paper this summer or JOSS would be a relatively low lift) with the current development team

@ssolson
Copy link
Contributor

ssolson commented May 17, 2024

A new citation is generated for every release. The cite all versions is the one we should show. This list of Authors should be automatically updated with the github contributors. https://zenodo.org/records/11148583

Basically no one uses this so I wouldn't spend too much brain power on it.

@rebeccamccabe
Copy link

hi, I am a user of MHKit and I got an error when using the provided bibtex key for matlab. I wanted to let you know that there is a missing bracket after the url, bolded below.


@misc{MHKiT_MATLAB,
    title = {MHKiT (Marine and Hydrokinetic Toolkit) - MATLAB},
    author = {Pauly, Rebecca and Klise, Katherine and Ruehl, Kelley M. and Olson, Sterling and Shippert, Timothy and Morrell, Zachary and Bredin, Sarah and Lansing, Carina and Macduff, Matt and Martin, Tonya and Sivaraman, Chitra and Gunawan, Budi and Driscoll, Frederick},
    abstractNote = {The MHKiT Code Hub is a collection of open-source marine renewable energy (MRE) software. The MHKiT code, developed in Python and MATLAB, includes modules for ingesting, quality controlling, processing, visualizing, and managing data. MHKiT-Python and MHKiT-MATLAB provide robust and verified functions in both Python and MATLAB that are needed by the MRE community to standardize data processing. Calculations and visualizations adhere to IEC technical specifications and other guidelines. Current functionality includes power performance, power quality, mechanical loads, resource tools, and data quality control for wave, tidal, and river applications.},
    url = {https://doi.org/10.5281/zenodo.3928405},
    howpublished = {[Computer Software] \url{https://doi.org/10.5281/zenodo.3928405}},
    year = {2020},
    month = {jan},
    doi       = {10.5281/zenodo.3928405}
}

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

4 participants