Skip to content

More detailed and accurate parameter descriptions#297

Merged
ConnorStoneAstro merged 8 commits intodevfrom
paramdescriptions
Apr 2, 2026
Merged

More detailed and accurate parameter descriptions#297
ConnorStoneAstro merged 8 commits intodevfrom
paramdescriptions

Conversation

@ConnorStoneAstro
Copy link
Copy Markdown
Member

No description provided.

@ConnorStoneAstro ConnorStoneAstro added the docs Improvements or additions to documentation label Apr 2, 2026
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 2, 2026

Codecov Report

❌ Patch coverage is 96.55172% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 91.55%. Comparing base (ac7b90a) to head (0c775be).
⚠️ Report is 24 commits behind head on dev.

Files with missing lines Patch % Lines
astrophot/models/mixins/transform.py 75.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##              dev     #297      +/-   ##
==========================================
- Coverage   92.37%   91.55%   -0.83%     
==========================================
  Files         117      112       -5     
  Lines        5785     6048     +263     
==========================================
+ Hits         5344     5537     +193     
- Misses        441      511      +70     
Flag Coverage Δ
unittests 91.55% <96.55%> (-0.83%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ConnorStoneAstro ConnorStoneAstro marked this pull request as ready for review April 2, 2026 18:44
Copilot AI review requested due to automatic review settings April 2, 2026 18:44
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates model/docstring parameter descriptions across AstroPhot’s model zoo and tutorials, while also introducing several behavioral/API changes to PSF normalization, Gaussian/Airy profile definitions, and some model initializations.

Changes:

  • Expand/clarify docstrings and tutorial notebook parameter explanations (sampling/integration, sky/PSF models, Sersic/Exponential/Gaussian, etc.).
  • Refactor PSF normalization control to be a call-time argument (normalize_psf) rather than a construction-time option/attribute.
  • Update/adjust a few model behaviors (e.g., Airy PSF parameterization, Fourier phase validity bounds, PixelBasisPSF weight initialization) and relax/skip parts of some tests.

Reviewed changes

Copilot reviewed 27 out of 27 changed files in this pull request and generated 7 comments.

Show a summary per file
File Description
tests/test_psfmodel.py Adjust PSF-model test skips/fit assertions; modifies pixelated PSF parameter assignment.
tests/test_model.py Tweaks model skip logic for warp/fourier/truncated variants.
docs/source/tutorials/ModelZoo.ipynb Updates Airy PSF example parameter name/value.
docs/source/tutorials/GettingStarted.ipynb Adds printing of parameter descriptions in tutorial output.
docs/source/tutorials/AdvancedPSFModels.ipynb Removes normalize_psf constructor usage from examples.
astrophot/models/sky_model_object.py Changes __all__ style to tuple.
astrophot/models/psf_model_object.py Updates PSFModel docs and changes normalization behavior/control surface.
astrophot/models/point_source.py Removes unused torch-related imports/decorators; doc wording tweaks.
astrophot/models/planesky.py Removes torch dependency in sky model; doc wording tweaks.
astrophot/models/pixelated_psf.py Improves parameter description; removes torch decorator/import.
astrophot/models/pixelated_model.py Improves parameter description; removes torch decorator/import.
astrophot/models/multi_gaussian_expansion.py Updates PA description text.
astrophot/models/mixins/transform.py Updates doc wording; adjusts Fourier phim valid range handling; changes truncation init.
astrophot/models/mixins/spline.py Updates doc wording (Tensor→Array).
astrophot/models/mixins/sersic.py Expands Re/Ie descriptions (effective radius/intensity wording).
astrophot/models/mixins/sample.py Rewrites SampleMixin docstring with more detailed integration guidance.
astrophot/models/mixins/gaussian.py Updates Gaussian docstring and parameter description text.
astrophot/models/mixins/exponential.py Expands Re/Ie descriptions for exponential profiles.
astrophot/models/group_psf_model.py Updates PSFGroupModel docs; changes normalization control surface.
astrophot/models/gaussian_ellipsoid.py Removes torch decorator/import.
astrophot/models/func/gaussian.py Changes Gaussian functional form/normalization.
astrophot/models/flatsky.py Clarifies I0 parameter description/units.
astrophot/models/bilinear_sky.py Expands docs; changes PA/scale dynamic flags; refactors initialization.
astrophot/models/batch_model_object.py Improves RST link formatting and batch-parameter explanation.
astrophot/models/basis_psf.py Expands docstring; changes default weights initialization (now randomized + scaled).
astrophot/models/airy.py Refactors Airy PSF parameters (aRL→R1), updates docs and sampling expression.
astrophot/fit/lm.py Removes torch import and torch.no_grad() decorators.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@ConnorStoneAstro ConnorStoneAstro merged commit 12f5282 into dev Apr 2, 2026
13 of 14 checks passed
@ConnorStoneAstro ConnorStoneAstro deleted the paramdescriptions branch April 2, 2026 19:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants