Skip to content

Update formatting of additional pvlib publications #2011

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Apr 13, 2024
Merged

Update formatting of additional pvlib publications #2011

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f6bafa8
Update additional pvlib publications
AdamRJensen Apr 12, 2024
713d168
Use DOI sphinx role
AdamRJensen Apr 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 13 additions & 9 deletions docs/sphinx/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,26 +82,30 @@ pvlib python that you used. pvlib python DOIs are listed at

Additional pvlib python publications include:

* J. S. Stein, “The photovoltaic performance modeling
collaborative (PVPMC),” in Photovoltaic Specialists Conference, 2012.
* J. S. Stein, "The Photovoltaic Performance Modeling Collaborative (PVPMC),"
2012 38th IEEE Photovoltaic Specialists Conference (PVSC),
Austin, TX, USA, 2012, pp. 003048-003052, https://doi.org/10.1109/PVSC.2012.6318225.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it more common to add the raw link in the IEEE format or DOI: 10.1109/PVSC.2012.6318225 ?

I think these dois could make use of the role :doi:``

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

DOI is certainly to be preferred.

I've switched to the doi role, though I don't exactly know the benefit

Copy link
Contributor

@echedey-ls echedey-ls Apr 12, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for not being clear enough regarding the "raw link".

You can either put:

The first one is with the DOI role and the second one is the one I was referring to with "raw link".

Edit: for clarification, those are the ways they get rendered on the page.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The HTTP link for DOIs is fairly compact, so I don't have a strong preference for either one. Let's just go with the DOI role for this PR.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMHO it’s not an either/or situation. As the title of this PR suggests there is or should be a standard way to format & render references, which uses the doi role that was explicitly created for this purpose. If it is not functional then it should probably be removed from the Sphinx config file. Maybe this needs to be documented somewhere?

* R. W. Andrews, J. S. Stein, C. Hansen and D. Riley, "Introduction to the open
source PV LIB for python Photovoltaic system modelling package,"
2014 IEEE 40th Photovoltaic Specialist Conference (PVSC), Denver, CO, USA,
2014, pp. 0170-0174, https://doi.org/10.1109/PVSC.2014.6925501
2014 IEEE 40th Photovoltaic Specialist Conference (PVSC),
Denver, CO, USA, 2014, pp. 0170-0174, https://doi.org/10.1109/PVSC.2014.6925501
(`paper
<https://www.osti.gov/servlets/purl/1241774>`__)
* W.F. Holmgren, R.W. Andrews, A.T. Lorenzo, and J.S. Stein,
“PVLIB Python 2015,” in 42nd Photovoltaic Specialists Conference, 2015.
* W.F. Holmgren, R.W. Andrews, A.T. Lorenzo, and J.S. Stein, "PVLIB Python 2015,"
2015 IEEE 42nd Photovoltaic Specialist Conference (PVSC),
New Orleans, LA, USA, 2015, pp. 1-5, https://doi.org/10.1109/PVSC.2015.7356005
(`paper
<https://github.com/pvlib/pvsc2015/blob/main/pvlib_pvsc_42.pdf>`__ and
the `notebook to reproduce the figures
<http://nbviewer.org/github/pvlib/pvsc2015/blob/main/paper.ipynb>`_)
* J.S. Stein, W.F. Holmgren, J. Forbess, and C.W. Hansen,
"PVLIB: Open Source Photovoltaic Performance Modeling Functions
for Matlab and Python," in 43rd Photovoltaic Specialists Conference, 2016.
"PVLIB: Open Source Photovoltaic Performance Modeling Functions for Matlab and Python,"
2016 IEEE 43rd Photovoltaic Specialists Conference (PVSC),
Portland, OR, USA, 2016, pp. 3425-3430, https://doi.org/10.1109/PVSC.2016.7750303.
* W.F. Holmgren and D.G. Groenendyk,
"An Open Source Solar Power Forecasting Tool Using PVLIB-Python,"
in 43rd Photovoltaic Specialists Conference, 2016.
2016 IEEE 43rd Photovoltaic Specialists Conference (PVSC),
Portland, OR, USA, 2016, pp. 0972-0975, https://doi.org/10.1109/PVSC.2016.7749755.


Logo
Expand Down
2 changes: 1 addition & 1 deletion docs/sphinx/source/user_guide/comparison_pvlib_matlab.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Comparison with PVLIB MATLAB
****************************

PVLIB was originally developed as a library for MATLAB at Sandia
pvlib was originally developed as a library for MATLAB at Sandia
National Lab, and Sandia remains the official maintainer of the MATLAB
library. Sandia supported the initial Python port and
then released further project maintenance and development to the
Expand Down