Skip to content

Possible improvement to pvlib.soiling.hsu documentation #2534

@ramaroesilva

Description

@ramaroesilva

Describe the bug
hsu model documentation mentions that the output

soiling_ratio (Series) – Values between 0 and 1. Equal to 1 - transmission loss.

While the soiling ratio ranges 0-1, broadly speaking, it is also true that this model internally caps its minimum value at 0.6563 (i.e., 1-0.3437). For example, in the kimber model this cap is a user-defined parameter.

To Reproduce
Steps to reproduce the behavior:

  1. Go to hsu model documentation
  2. Check the description of the returned output

Expected behavior
The documentation could mention that the model implicitly defines a minimum value for the soiling ratio of 0.6563.

Versions:

  • pvlib.__version__: 0.13.0

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions