Merge pull request #434 from NREL/fix_issue_#305

add citation.cff file

Author: mdeceglie

CITATION.cff

@@ -0,0 +1,46 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+authors:
+- family-names: "Deceglie"
+  given-names: "Michael G."
+  orcid: "https://orcid.org/0000-0001-7063-9676"
+- family-names: "Anderson"
+  given-names: "Kevin"
+- family-names: "Shinn"
+  given-names: "Adam"
+- family-names: "Ambarish"
+  given-names: "Nag"
+- family-names: "Mikofski"
+  given-names: "Mark"
+  orcid: "https://orcid.org/0000-0001-8001-8582"
+- family-names: "Springer"
+  given-names: "Martin"
+  orcid: "https://orcid.org/0000-0001-6803-108X"
+- family-names: "Yan"
+  given-names: "Jiyang"
+- family-names: "Perry"
+  given-names: "Kirsten"
+- family-names: "Villamar"
+  given-names: "Sandra"
+- family-names: "Vining"
+  given-names: "Will"
+- family-names: "Kimball"
+  given-names: "Gregory M."
+  orcid: "https://orcid.org/0000-0003-1075-1417"
+- family-names: "Ruth"
+  given-names: "Daniel"
+- family-names: "Moyer"
+  given-names: "Noah"
+- family-names: "Nguyen"
+  given-names: "Quyen"
+- family-names: "Jordan"
+  given-names: "Dirk"
+  orcid: "https://orcid.org/0000-0002-2183-7489"
+- family-names: "Muller"
+  given-names: "Matthew"
+- family-names: "Deline"
+  given-names: "Chris"
+  orcid: "https://orcid.org/0000-0002-9867-8930"
+title: "RdTools"
+doi: 10.5281/zenodo.1210316
+url: "https://github.com/NREL/rdtools"

README.md

@@ -13,7 +13,7 @@ RdTools is an open-source library to support reproducible technical analysis of
 time series data from photovoltaic energy systems. The library aims to provide
 best practice analysis routines along with the building blocks for users to
 tailor their own analyses. Current applications include the evaluation of PV
-production over several years to obtain rates of performance degradation and 
+production over several years to obtain rates of performance degradation and
 soiling loss. RdTools can handle both high frequency (hourly or better) or low
 frequency (daily, weekly, etc.) datasets. Best results are obtained with higher
 frequency data.
@@ -34,10 +34,10 @@ RdTools currently is tested on Python 3.9+.
 To cite RdTools, please use the following along with the version number
 and the specific DOI coresponding to that version from [Zenodo](https://doi.org/10.5281/zenodo.1210316):
 
--  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}, Computer Software,
+-  Michael G. Deceglie, Kevin Anderson,  Adam Shinn, Ambarish Nag, Mark Mikofski,
+   Martin Springer, Jiyang Yan, Kirsten Perry, Sandra Villamar, Will Vining,
+   Gregory Kimball, Daniel Ruth, Noah Moyer, Quyen Nguyen, Dirk Jordan,
+   Matthew Muller, and Chris Deline, RdTools, version {insert version}, Computer Software,
    https://github.com/NREL/rdtools. DOI:{insert DOI}
 
 The underlying workflow of RdTools has been published in several places.

docs/sphinx/source/changelog/pending.rst

@@ -2,7 +2,12 @@
 v3.0.0 (December XX, 2024)
 **************************
 
+Enhancements
+------------
+* Add `CITATION.cff` file for citation information (:pull:`434`)
+
 
 Bug fixes
 ---------
-* Set marker linewidth to zero in :py:func:`~rdtools.plotting.degradation_summary_plots` (:pull:`433`)
+* Set marker linewidth to zero in :py:func:`~rdtools.plotting.degradation_summary_plots` (:pull:`433`)
+