Skip to content

irradiance.king documentation and output naming is wrong #2636

@ramaroesilva

Description

@ramaroesilva

Describe the bug

The King model is unclear and not even correct. Tbh, this is to be expected as the pvlib documentation irradiance.king explicitly assumes:

Note that this model is not well documented and has not been published in any fashion (as of January 2012).

The equation for King's model in PVPMC's webpage describes an isotropic transposition for both sky and ground diffuse assuming a zenith-dependent albedo. However, within pvlib the irradiance.king this is not made clear and it even mentions

"ground reflected irradiance is not included in this algorithm"

And while the output is poa_diffuse, it is identified as poa_sky_diffuse.

Expected behavior
Would propose that documentation and variable naming is corrected. Could also split the poa in sky and ground. @cwhanse proposed here that due to lack of proper documentation this function could be deprecated.

Would it be worth to include the ground diffuse implementation within irradiance.get_ground_diffuse?

Screenshots
Equation from PVPMC:

Image

Versions:

  • pvlib.__version__: 0.13.1

Additional context
Add any other context about the problem here.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions