Add examples for run_model_from_poa() and run_model_from_effective_irradiance()#2621
Add examples for run_model_from_poa() and run_model_from_effective_irradiance()#2621Chirag3841 wants to merge 24 commits intopvlib:mainfrom
Conversation
|
@cwhanse |
Co-authored-by: Cliff Hansen <cwhanse@sandia.gov>
|
@cwhanse |
|
@cwhanse |
Have you tried to run the examples? When I do, I get errors: Array is not imported, Array doesn't take |
|
Okay sir I will do that |
8e54b17 to
af125da
Compare
|
@cwhanse Now,I ran the doctest cases carefully, and everything passed without any errors. |
|
@Chirag3841 can you fix the lint error, and also, merge pvlib:main into this branch? The doc build failure was fixed recently, has to do with pandas frequency strings and not with your PR. |
|
@cwhanse I have removed that lint issue in line number 1943 and merge pvlib:main into this branch. |
cwhanse
left a comment
There was a problem hiding this comment.
Please add a note to the Documentation section in this file https://github.com.mcas-gov.ms/pvlib/pvlib-python/blob/main/docs/sphinx/source/whatsnew/v0.15.1.rst
Co-authored-by: Cliff Hansen <cwhanse@sandia.gov>
Co-authored-by: Cliff Hansen <cwhanse@sandia.gov>
Co-authored-by: Cliff Hansen <cwhanse@sandia.gov>
Co-authored-by: Cliff Hansen <cwhanse@sandia.gov>
Co-authored-by: Cliff Hansen <cwhanse@sandia.gov>
|
@cwhanse I have added that note in documentation section in this PR. |
@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.