Skip to content

docs: update solar angle definitions in nomenclature #2482

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 5 commits into from

Conversation

OmarBahamida
Copy link

  • Add detailed definitions for solar angles with range constraints
  • Clarify pvlib's east-of-north convention for azimuth angles
  • Add cross-references between related terms using :term: directive
  • Add coordinate system conventions for latitude/longitude
  • Enhance existing angle definitions with usage notes and examples

This commit addresses issue #2448 by migrating angle definitions and conventions from parameter descriptions to the nomenclature page.

  • Closes #xxxx
  • I am familiar with the contributing guidelines
  • Tests added
  • Updates entries in docs/sphinx/source/reference for API changes.
  • Adds description and name entries in the appropriate "what's new" file in docs/sphinx/source/whatsnew for 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`).
  • New code is fully documented. Includes numpydoc compliant docstrings, examples, and comments where necessary.
  • Pull request is nearly complete and ready for detailed review.
  • Maintainer: Appropriate GitHub Labels (including remote-data) and Milestone are assigned to the Pull Request and linked Issue.

- Add detailed definitions for solar angles with range constraints
- Clarify pvlib's east-of-north convention for azimuth angles
- Add cross-references between related terms using :term: directive
- Add coordinate system conventions for latitude/longitude
- Enhance existing angle definitions with usage notes and examples

This commit addresses issue pvlib#2448 by migrating angle definitions and
conventions from parameter descriptions to the nomenclature page.
- Introduced a new function to infer updated coefficients for the Huld model based on EU JRC research.
- Added a parameter to the existing Huld function to optionally use these updated coefficients.
- Updated documentation to reflect the new functionality and included references to the EU JRC paper.
- Added tests to verify the implementation and ensure compatibility with existing functionality.
- Updated the test for the Huld model to use non-reference values for irradiance and temperature.
- Enhanced the test to verify that results differ for all supported cell types when using EU JRC coefficients.
- Added checks to ensure all cell types are supported and that a KeyError is raised for invalid cell types.
- Created test_solar_angles.py to verify solar angle calculations
- Tests zenith, azimuth, and elevation angles for different times of day
- Uses New York City as example location on spring equinox
- Verifies angles are within expected ranges and follow correct patterns
…s/test_solarposition.py

- Deleted the standalone test_solar_angles.py file.
- Added a new test function, test_solar_angles_spring_equinox, to tests/test_solarposition.py.
- The new test verifies solar angles for New York City on the spring equinox, ensuring angles are within expected ranges and follow correct patterns.
@cwhanse
Copy link
Member

cwhanse commented Jun 16, 2025

@OmarBahamida could you separate these changes into two pull requests? One for the nomenclature, and the other for the Huld coefficients. It's much easier to review in smaller parts.

@cwhanse
Copy link
Member

cwhanse commented Jun 17, 2025

@OmarBahamida if this PR is superceded by the others, please close.

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