-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Open
Description
Is your feature request related to a problem? Please describe.
The behavior of pvlib.transformer.simple_efficiency when load_loss = 0
is currently not documented.
In this case, the quadratic formulation leads to a division-by-zero
situation, resulting in NaN outputs or runtime warnings depending on
the execution context. While this behavior is being addressed in code,
the expected behavior and limitations of the model are not clearly
communicated to users.
Describe the solution you'd like
Add clarification to the simple_efficiency docstring and/or
documentation to explicitly state:
- That the model assumes
load_loss > 0 - What happens when
load_loss = 0 - Whether this represents an unsupported or degenerate case
This would help users understand model assumptions without needing to
inspect the implementation or encounter runtime warnings.
Additional context
Related issues and PRs:
- simple_efficiency raises ZeroDivisionError when load_loss=0 #2645 (division by zero when
load_loss = 0) - Fix ZeroDivisionError in simple_efficiency when load_loss=0 #2646 (code changes addressing this behavior)
This issue focuses only on documentation and user-facing clarity.
@
Metadata
Metadata
Assignees
Labels
No labels