Fix in ModelChain effective_irradiance methods by adding examples #2603
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
docs/sphinx/source/reference(not required — API unchanged)Address the documentation portion of #943
This pull request improves the documentation for
ModelChain.run_model_from_effective_irradiance() by adding a complete, runnable example to the
docstring.
Changes demonstrates-
1)Providing effective irradiance as the primary model input
Shows how users can bypass POA and spectral steps when effective irradiance is already calculated.
2)Creating a minimal DataFrame containing:
• effective_irradiance (required)
• temp_air and wind_speed (optional weather inputs)
3)Running the model using run_model_from_effective_irradiance
Illustrates how ModelChain handles temperature, DC, and AC modeling starting from effective irradiance.
4)Ensuring formatting and indentation follow pvlib’s numpydoc standards
Docstring follows pvlib conventions:
• Examples block
• Proper indentation
• Consistent parameter formatting
• Clear Notes section
@cwhanse I have done the changes for PR3.