Skip to content

Update illumination factor convention#332

Merged
dhutererprats merged 2 commits intodevelopfrom
update_illuminationFactor_convention
Feb 25, 2026
Merged

Update illumination factor convention#332
dhutererprats merged 2 commits intodevelopfrom
update_illuminationFactor_convention

Conversation

@dhutererprats
Copy link
Contributor

@dhutererprats dhutererprats commented Feb 20, 2026

Description

Closes #

This PR standardizes naming from shadow-based terms to illumination-based terms in the RSO inspection/eclipsing paths.

Summary

  • Renamed remaining internal usage to illumination naming:
    • min_illumination_factor
    • illuminationFactor
  • Updated wording in RSO points module docs from shadowing to occlusion terminology.
  • No intended behavior change; this is a naming/consistency cleanup.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

How should this pull request be reviewed?

  • By commit
  • All changes at once

How Has This Been Tested?

  • git grep -n -E "shadowFactor|min_shadow_factor|shadow_factor" src/bsk_rl tests/unittest (no matches)
  • .venv/bin/python -m py_compile src/bsk_rl/scene/rso_points.py src/bsk_rl/sim/dyn/rso_inspection.py src/bsk_rl/utils/orbital.py
  • Verified Basilisk fields exist in this environment (min_illumination_factor and illuminationFactor).

Note: full pytest execution in this sandbox is still blocked by local pandas binary policy.

Future Work

N/A

Checklist

  • I have performed a self-review of my code
  • I have commented my code in hard-to-understand areas
  • I have made corresponding changes to the documentation and release notes
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works

@dhutererprats dhutererprats force-pushed the update_illuminationFactor_convention branch from cadd7a1 to 5b2c423 Compare February 20, 2026 00:04
Copy link
Contributor

@Mark2000 Mark2000 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Could you add a note in the release notes alerting people to the change?

@dhutererprats dhutererprats added bug Something isn't working documentation Improvements or additions to documentation labels Feb 24, 2026
@dhutererprats dhutererprats self-assigned this Feb 24, 2026
@dhutererprats dhutererprats merged commit d76714b into develop Feb 25, 2026
24 of 28 checks passed
@dhutererprats dhutererprats deleted the update_illuminationFactor_convention branch February 25, 2026 01:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants