Skip to content
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

fix remaining i2d mentions and add coadd suffix #1548

Closed
wants to merge 1 commit into from

Conversation

braingram
Copy link
Collaborator

@braingram braingram commented Dec 2, 2024

This PR removes the remaining i2d suffix mentions in the docs and adds coadd to the understood suffixes.

The addition of coadd to the suffixes is required for steps that process _coadd files (like SourceCatalog) to allow them to remove the previous file suffix when saving a result with a new suffix. For example the source catalog step is currently failing on main due to failure to remove the coadd suffix as seen in the following log messages:

INFO     stpipe.SourceCatalogStep:step.py:1037 Saved model in r0099101001001001001_r274dp63x31y81_prompt_F158_coadd_segm.asdf
INFO     stpipe.SourceCatalogStep:step.py:1037 Saved model in r0099101001001001001_r274dp63x31y81_prompt_F158_coadd_cat.asdf
INFO     stpipe.SourceCatalogStep:step.py:1037 Saved model in r0099101001001001001_r274dp63x31y81_prompt_F158_coadd_cat.asdf

Note that coadd wasn't removed from the filename leading to regtest failures since the above files have unexpected names.

Regression tests: https://github.com/spacetelescope/RegressionTests/actions/runs/12126363248

Tasks

  • request a review from someone specific, to avoid making the maintainers review every PR
  • add a build milestone, i.e. 24Q4_B15 (use the latest build if not sure)
  • Does this PR change user-facing code / API? (if not, label with no-changelog-entry-needed)
    • write news fragment(s) in changes/: echo "changed something" > changes/<PR#>.<changetype>.rst (see below for change types)
    • update or add relevant tests
    • update relevant docstrings and / or docs/ page
    • start a regression test and include a link to the running job (click here for instructions)
      • Do truth files need to be updated ("okified")?
        • after the reviewer has approved these changes, run okify_regtests to update the truth files
  • if a JIRA ticket exists, make sure it is resolved properly
news fragment change types...
  • changes/<PR#>.general.rst: infrastructure or miscellaneous change
  • changes/<PR#>.docs.rst
  • changes/<PR#>.stpipe.rst
  • changes/<PR#>.associations.rst
  • changes/<PR#>.scripts.rst
  • changes/<PR#>.mosaic_pipeline.rst
  • changes/<PR#>.patch_match.rst

steps

  • changes/<PR#>.dq_init.rst
  • changes/<PR#>.saturation.rst
  • changes/<PR#>.refpix.rst
  • changes/<PR#>.linearity.rst
  • changes/<PR#>.dark_current.rst
  • changes/<PR#>.jump_detection.rst
  • changes/<PR#>.ramp_fitting.rst
  • changes/<PR#>.assign_wcs.rst
  • changes/<PR#>.flatfield.rst
  • changes/<PR#>.photom.rst
  • changes/<PR#>.flux.rst
  • changes/<PR#>.source_detection.rst
  • changes/<PR#>.tweakreg.rst
  • changes/<PR#>.skymatch.rst
  • changes/<PR#>.outlier_detection.rst
  • changes/<PR#>.resample.rst
  • changes/<PR#>.source_catalog.rst

@github-actions github-actions bot added documentation Improvements or additions to documentation pipeline associations labels Dec 2, 2024
@braingram braingram marked this pull request as ready for review December 2, 2024 17:40
@braingram braingram requested a review from a team as a code owner December 2, 2024 17:40
@braingram braingram requested a review from schlafly December 2, 2024 17:42
Copy link

codecov bot commented Dec 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.69%. Comparing base (6e73a27) to head (4c39a4b).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1548   +/-   ##
=======================================
  Coverage   76.69%   76.69%           
=======================================
  Files         120      120           
  Lines        7830     7830           
=======================================
  Hits         6005     6005           
  Misses       1825     1825           

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

Copy link
Collaborator

@schlafly schlafly left a comment

Choose a reason for hiding this comment

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

Thanks Brett! @ddavis-stsci , look good to you?

@braingram braingram closed this Dec 2, 2024
@braingram braingram deleted the fix_i2d_coadd branch December 2, 2024 20:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants