Add examples for run_model_from_poa() and run_model_from_effective_irradiance() #2621
+86
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Author
|
@cwhanse |
cwhanse
reviewed
Dec 11, 2025
Co-authored-by: Cliff Hansen <cwhanse@sandia.gov>
Author
|
@cwhanse |
Author
|
@cwhanse |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
@cwhanse
docs/sphinx/source/referencefor API changes.docs/sphinx/source/whatsnewfor all changes. Includes link to the GitHub Issue with:issue:`num`or this Pull Request with:pull:`num`. Includes contributor name and/or GitHub username (link with:ghuser:`user`).remote-data) and Milestone are assigned to the Pull Request and linked Issue.Description
This pull request adds clear and practical usage examples to the run_model_from_poa and run_model_from_effective_irradiance methods in pvlib.modelchain.ModelChain. These two functions are widely used, but until now the documentation did not contain complete examples demonstrating how to prepare input data or how the methods should be used in real workflows.
This PR introduces both single-array and multi-array examples for each method. The single-array examples show a minimal and straightforward modeling setup using PVSystem, Location, and ModelChain along with the required irradiance or effective irradiance DataFrame. The multi-array examples demonstrate how to correctly structure per-array inputs, showing how users should supply multiple DataFrames with aligned indexes and consistent ordering to match the system’s arrays.
These examples are especially important because multi-array usage is not intuitive without seeing a working format.