Skip to content

Conversation

@Chirag3841
Copy link

@Chirag3841 Chirag3841 commented Nov 27, 2025

  • Closes Run ModelChain from POA irradiance #943 (documentation portion: adds examples to run_model_from_effective_irradiance)
  • I am familiar with the contributing guidelines
  • Tests added (not required for documentation-only PR)
  • Updates entries in docs/sphinx/source/reference (not required — API unchanged)
  • Adds description and name entries in the "what's new" file (not required for minor doc updates)
  • New code is fully documented (docstrings updated with numpydoc-compliant examples)
  • Pull request is nearly complete and ready for detailed review
  • Maintainer: add labels and milestone

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.

@Chirag3841
Copy link
Author

@cwhanse
I have done changes in run_model_effective_irradiance() method by adding example.

@cwhanse
Copy link
Member

cwhanse commented Dec 1, 2025

@Chirag3841 this PR is also stacked on top of #2601. Please rebase on to pvlib's main.

@Chirag3841 Chirag3841 force-pushed the fix-effective-irrad branch 2 times, most recently from b217fc0 to ea67ef8 Compare December 2, 2025 08:11
@Chirag3841
Copy link
Author

@cwhanse
Changes applied. Please review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants