-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Inappropriate reference for the function "dc_ohmic_losses" #1601
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.
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
Comments
Listing of this function in the Pvsyst group of "PV System Models" documentation is meant to communicate that Pvsyst applies ohmic losses using this method (the "Array ohmic losses page" in the Help document). It wasn't intended to imply that Pvsyst originated the equation (the latter is usually indicated by the name of the function). The function could certainly be listed in other groupings in the API documentation. Maybe we should explain what we mean by "PV System Models" - in my mind these are collections of functions that together emulate some named model. |
Yes, and perhaps we should try to distinguish between models and software. For me, PVsyst is a software package which implements some generic/basic models/equations, some tweaked standard models, and some original models. |
Perhaps we can just change these lines (as the title of the issue suggests) and leave the API documentation questions for other day since that's already in flux in other places: pvlib-python/pvlib/pvsystem.py Lines 3317 to 3321 in 8e0b724
pvlib-python/pvlib/pvsystem.py Lines 3352 to 3356 in 8e0b724
|
Thumbs up also to only change the references in the docstrings, but I would like to at least retain a comment that connects these functions with the way Pvsyst does things. If for no other reason, for future work on something like |
Describe the bug
The function
dc_ohmic_losses
consists of one line:which is clearly an elementary electrical calculation.
The pvlib documentation provides a reference to the PVsyst documentation and organizes this function under the PVsyst banner in the documentation.
I think this is a bit strange, and could give the impression that this is something invented by/for PVsyst.
The same could be said about the function
dc_ohms_from_percent
.Desired behavior
It would be preferable to have basic functions like this without such specific attributions/associations. A reference, if judged necessary, could be to a simple textbook. It could be useful to provide the information that PVsyst uses these elementary equations, which could be mentioned in the Notes section perhaps--ideally with information about other software too.
The text was updated successfully, but these errors were encountered: