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 bug in AmiAverageStep spec that prevents step creation #8677

Merged
merged 2 commits into from
Jul 29, 2024

Conversation

braingram
Copy link
Collaborator

@braingram braingram commented Jul 26, 2024

The step spec for AmiAverageStep contains an invalid entry:

spec = """
skip = True # Do not run this step
"""

which leads to an error when attempting to construct the step:

ValidationError: Config parameter 'skip': missing

This PR fixes the spec and adds a very basic unit test to verify the step can be instantiated.

Checklist for PR authors (skip items if you don't have permissions or they are not applicable)

  • added entry in CHANGES.rst within the relevant release section
  • updated or added relevant tests
  • updated relevant documentation
  • added relevant milestone
  • added relevant label(s)
  • ran regression tests, post a link to the Jenkins job below.
    How to run regression tests on a PR
  • All comments are resolved
  • Make sure the JIRA ticket is resolved properly

@braingram
Copy link
Collaborator Author

braingram commented Jul 26, 2024

Given that this step couldn't be created I am inclined to skip regression tests as the step is effectively untested.

@braingram braingram marked this pull request as ready for review July 26, 2024 16:17
@braingram braingram requested a review from a team as a code owner July 26, 2024 16:17
@braingram braingram changed the title fix bug in AmiAverageStep spec fix bug in AmiAverageStep spec that prevents step creation Jul 26, 2024
@tapastro
Copy link
Contributor

A question related to this PR: do you know if NIRISS expects this step to be used? It is not part of the reworked AMI pipeline, right?

Copy link

codecov bot commented Jul 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 60.47%. Comparing base (7198d89) to head (cf91724).

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #8677      +/-   ##
==========================================
+ Coverage   60.36%   60.47%   +0.10%     
==========================================
  Files         372      369       -3     
  Lines       38320    38408      +88     
==========================================
+ Hits        23132    23226      +94     
+ Misses      15188    15182       -6     

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

@braingram
Copy link
Collaborator Author

A question related to this PR: do you know if NIRISS expects this step to be used? It is not part of the reworked AMI pipeline, right?

Thanks for giving it a look. I don't believe they expect this to be used (currently) based on the comment in the description for #7862:

ami_average:

This step will be turned off in the default AMI3 pipeline flow until the effects of averaging together multiple reference star observations are better understood. The code is left as-is except "skip = True" has been added to the spec block. This step will not work if run manually on the AmiOIModel products.

Perhaps @rcooper295 knows more.

I only noticed the issue fixed in this PR because I tried to create a basic instance of every step (to try and wrangle the suffix calculations since that appears to be one limitation for removing the deprecated cfg files in the pipeline directory. See #8664 for not really details but at least the current failures with the cfg files removed).

Copy link
Contributor

@tapastro tapastro left a comment

Choose a reason for hiding this comment

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

Pending rebase, LGTM

@braingram braingram enabled auto-merge July 29, 2024 13:33
@braingram braingram merged commit c728859 into spacetelescope:master Jul 29, 2024
27 checks passed
@braingram braingram deleted the ami_average_spec branch July 29, 2024 18:01
@nden nden added this to the Build 11.1 milestone Sep 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants