MHKiT-Software / MHKiT

MHKiT Documentation
https://MHKiT-Software.github.io/MHKiT/
4 stars 13 forks source link

Citations seem out of date #68

Open simmsa opened 1 month ago

simmsa commented 1 month ago

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

akeeste commented 1 month ago

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:

ssolson commented 1 month ago

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 commented 1 month ago

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}
}