Skip to content

Commit

Permalink
Misc updates (#94)
Browse files Browse the repository at this point in the history
* removing redundant materials in contributing page

* removed cff file

* update citation for pvops in readme and documentation
  • Loading branch information
kbonney authored Jan 29, 2024
1 parent 158f300 commit eec8b63
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 69 deletions.
23 changes: 0 additions & 23 deletions CITATION.cff

This file was deleted.

28 changes: 15 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
[![GitHub version](https://badge.fury.io/gh/sandialabs%2FpvOps.svg)](https://badge.fury.io/gh/sandialabs%2FpvOps)
[![License](https://img.shields.io/pypi/l/pvOps?color=green)](https://github.com/sandialabs/pvOps/blob/master/LICENSE)
[![ActionStatus](https://github.com/sandialabs/pvOps/workflows/lint%20and%20test/badge.svg)](https://github.com/sandialabs/pvOps/actions)
[![DOI](https://zenodo.org/badge/289032705.svg)](https://zenodo.org/badge/latestdoi/289032705)
[![status](https://joss.theoj.org/papers/6c3554c98b1771125613cff94241847c/status.svg)](https://joss.theoj.org/papers/6c3554c98b1771125613cff94241847c)

pvops contains a series of functions to facilitate fusion of text-based data with time series production data collected at photovoltaic sites. The package also contains example datasets and tutorials to help demonstrate how the functions can be used.
Expand Down Expand Up @@ -40,26 +39,29 @@ More information about these modules is available at [readthedocs](https://pvops
Citing
======

If using this package, please cite [our paper](https://ieeexplore.ieee.org/document/9518439) using the following:
If using this package, please cite our [JOSS paper](https://joss.theoj.org/papers/10.21105/joss.05755#) 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.
Bonney et al., (2023). pvOps: a Python package for empirical analysis of photovoltaic field data.
Journal of Open Source Software, 8(91), 5755, https://doi.org/10.21105/joss.05755
```

**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}}
@article{Bonney2023,
doi = {10.21105/joss.05755},
url = {https://doi.org/10.21105/joss.05755},
year = {2023},
publisher = {The Open Journal},
volume = {8},
number = {91},
pages = {5755},
author = {Kirk L. Bonney and Thushara Gunda and Michael W. Hopwood and Hector Mendoza and Nicole D. Jackson},
title = {pvOps: a Python package for empirical analysis of photovoltaic field data},
journal = {Journal of Open Source Software} }
```

Contributing
Expand All @@ -74,4 +76,4 @@ Logo Credit: [Daniel Rubinstein](http://www.danielrubinstein.com/)
Copyright and License
=======

pvops is copyright through Sandia National Laboratories. The software is distributed under the Revised BSD License. See [copyright and license](https://github.com/sandialabs/pvops/blob/master/LICENSE) for more information.
pvops is copyright through National Technology & Engineering Solutions of Sandia (NTESS). The software is distributed under the Revised BSD License. See the LICENSE file for more information.
21 changes: 0 additions & 21 deletions docs/pages/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,24 +61,3 @@ Guidelines for preparing and submitting pull-requests
the latest `master` commit

- Ensure that appropriate documentation and tests accompany any added features.


Once a pull-request is submitted you will iterate with NuMAD maintainers
until your changes are in an acceptable state and can be merged in. You can push
addditional commits to the branch used to create the pull-request to reflect the
feedback from maintainers and users of the code.

Questions and feature requests
--------------------------------

For any questions regarding pvOps or requests for additional features,
users may open an issue on the `pvops issues page <https://github.com/sandialabs/pvops/issues>`_
or contact the package maintainer found in ``setup.py``.

Guidelines for effective bug reporting
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- Use a clear, descriptive title for the question or feature request.

- If submitting a feature request, please provide context, examples, and
references when relevant.
25 changes: 13 additions & 12 deletions docs/pages/references.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,23 +8,24 @@ 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.
Bonney et al., (2023). pvOps: a Python package for empirical analysis of photovoltaic field data.
Journal of Open Source Software, 8(91), 5755, https://doi.org/10.21105/joss.05755
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}}
@article{Bonney2023,
doi = {10.21105/joss.05755},
url = {https://doi.org/10.21105/joss.05755},
year = {2023},
publisher = {The Open Journal},
volume = {8},
number = {91},
pages = {5755},
author = {Kirk L. Bonney and Thushara Gunda and Michael W. Hopwood and Hector Mendoza and Nicole D. Jackson},
title = {pvOps: a Python package for empirical analysis of photovoltaic field data},
journal = {Journal of Open Source Software} }
We also utilize content from other packages. See the NOTICE/ directory on our GitHub!
Expand Down

0 comments on commit eec8b63

Please sign in to comment.