Merge pull request #33 from sandialabs/add-references

add references and minor changes to linear model

Author: MichaelHopwood

README.md

@@ -32,6 +32,31 @@ The package is delineated into the following directories. Refer to the `examples
 
 More information about these modules is available at [readthedocs](https://pvops.readthedocs.io/en/latest/).
 
+Citing
+======
+
+If using this package, please cite [our paper](https://ieeexplore.ieee.org/document/9518439) using the following:
+
+**Citation:** 
+
+```
+H. Mendoza, M. Hopwood and T. Gunda, "pvOps: Improving Operational Assessments through Data Fusion," 2021 IEEE 48th Photovoltaic Specialists Conference (PVSC), 2021, pp. 0112-0119, doi: 10.1109/PVSC43889.2021.9518439.
+```
+
+**BibTex:**
+
+```
+@INPROCEEDINGS{9518439,
+  author={Mendoza, Hector and Hopwood, Michael and Gunda, Thushara},
+  booktitle={2021 IEEE 48th Photovoltaic Specialists Conference (PVSC)}, 
+  title={pvOps: Improving Operational Assessments through Data Fusion}, 
+  year={2021},
+  volume={},
+  number={},
+  pages={0112-0119},
+  doi={10.1109/PVSC43889.2021.9518439}}
+```
+
 Contributing
 ============
 

CITATION.cff renamed to citation.CIF

@@ -20,4 +20,4 @@ keywords:
   - data fusion
   - machine learning
   - natural language processing
-license: "BSD-3C"
+license: "BSD-3C"

docs/conf.py

@@ -55,7 +55,10 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ["sphinx.ext.autodoc", "nbsphinx", "nbsphinx_link"]
+extensions = ["sphinx.ext.autodoc",
+              "nbsphinx",
+              "nbsphinx_link",
+              "sphinx_copybutton"]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]

docs/references.rst

@@ -1,24 +1,45 @@
 References
 ==========
 
-This package has a DOI (soon)! If you publish using this package, please cite us:
+If using this package, please cite us using the following
+
+.. code-block:: text
+
+  H. Mendoza, M. Hopwood and T. Gunda, "pvOps: Improving Operational
+  Assessments through Data Fusion," 2021 IEEE 48th Photovoltaic Specialists
+  Conference (PVSC), 2021, pp. 0112-0119, doi: 10.1109/PVSC43889.2021.9518439.
+
+In BibTex format:
+
+.. code-block:: text
+
+  @INPROCEEDINGS{9518439,
+    author={Mendoza, Hector and Hopwood, Michael and Gunda, Thushara},
+    booktitle={2021 IEEE 48th Photovoltaic Specialists Conference (PVSC)}, 
+    title={pvOps: Improving Operational Assessments through Data Fusion}, 
+    year={2021},
+    volume={},
+    number={},
+    pages={0112-0119},
+    doi={10.1109/PVSC43889.2021.9518439}}
 
-[Placeholder for DOI]
 
 We also utilize content from other packages. See the NOTICE/ directory on our GitHub!
 
 Additionally, some of our own content comes from published papers. See the following external references.
 
 External references
-===================
+-------------------
 
 iv/
----
+^^^
 
+.. code-block:: text
 
-JW Bishop. "Computer simulation of the effects of electrical mismatches in photovoltaic cell 
-interconnection circuits", Solar Cell (1988) DOI: 10.1016/0379-6787(88)90059-2
+  JW Bishop. "Computer simulation of the effects of electrical mismatches in photovoltaic cell 
+  interconnection circuits", Solar Cell (1988) DOI: 10.1016/0379-6787(88)90059-2
 
+.. code-block:: text
 
-Hopwood, M. W., Gunda, T., Seigneur, H., & Walters, J. "Neural network-based classification 
-of string-level IV curves from physically-induced failures of photovoltaic modules", IEEE Access (2020), 8, 161480-161487.
+  Hopwood, M. W., Gunda, T., Seigneur, H., & Walters, J. "Neural network-based classification 
+  of string-level IV curves from physically-induced failures of photovoltaic modules", IEEE Access (2020), 8, 161480-161487.

docs/requirements.txt

@@ -1,3 +1,4 @@
 ipykernel
 nbsphinx
-nbsphinx-link
+nbsphinx-link
+sphinx-copybutton

docs/whatsnew/beta.rst

@@ -22,3 +22,8 @@ Bug fixes
 * Basic package fixes to README (PR #27) and documentation configuration (PR #24)
 * Fix IV simulator bug for edge case where two IV curves added have equal I_{sc} (PR #30)
 * Neural network configuration referencing in 1D CNN (PR #32)
+
+Docs
+~~~~
+
+* Update how to reference pvOps (PR #33)