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

Add docs for outlier detection step. #1042

Merged

Conversation

mairanteodoro
Copy link
Collaborator

@mairanteodoro mairanteodoro commented Dec 6, 2023

Resolves RCAL-503

This PR adds the documentation for the outlier detection step.

Successfully ran the regression tests, and the results are available here.

Checklist

  • added entry in CHANGES.rst under the corresponding subsection
  • updated relevant tests
  • updated relevant documentation
  • updated relevant milestone(s)
  • added relevant label(s)
  • ran regression tests, post a link to the Jenkins job below. How to run regression tests on a PR

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.

These look good to me. There are a few leftover references to JWST that should probably be purged, though it's also probably virtuous to reference that the step's heritage is from Webb. I forget whether the TSO code remained in the step or not; if not, it probably doesn't belong in the docs.

@nden
Copy link
Collaborator

nden commented Dec 14, 2023

@mairanteodoro What is the status of this? Is it ready to be moved out of Draft status?

@mairanteodoro mairanteodoro marked this pull request as ready for review December 14, 2023 20:04
@mairanteodoro mairanteodoro requested a review from a team as a code owner December 14, 2023 20:04
Copy link

codecov bot commented Dec 14, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 70.94%. Comparing base (d0fa876) to head (2f0cd4a).
Report is 476 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1042   +/-   ##
=======================================
  Coverage   70.94%   70.94%           
=======================================
  Files         105      105           
  Lines        6979     6979           
=======================================
  Hits         4951     4951           
  Misses       2028     2028           
Flag Coverage Δ *Carryforward flag
nightly 63.06% <ø> (ø) Carriedforward from d0fa876

*This pull request uses carry forward flags. Click here to find out more.

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

@mairanteodoro
Copy link
Collaborator Author

@mairanteodoro What is the status of this? Is it ready to be moved out of Draft status?

Yes, it is. Thanks for the reminder, @nden!

Copy link
Collaborator

@ddavis-stsci ddavis-stsci left a comment

Choose a reason for hiding this comment

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

A few, mostly minor comments, but I think it looks good.

docs/roman/outlier_detection/main.rst Outdated Show resolved Hide resolved
docs/roman/outlier_detection/main.rst Outdated Show resolved Hide resolved
docs/roman/outlier_detection/main.rst Show resolved Hide resolved
docs/roman/outlier_detection/outlier_detection_step.rst Outdated Show resolved Hide resolved
docs/roman/outlier_detection/outlier_detection.rst Outdated Show resolved Hide resolved
docs/roman/outlier_detection/outlier_detection.rst Outdated Show resolved Hide resolved
Copy link
Collaborator

@nden nden left a comment

Choose a reason for hiding this comment

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

The spec section does not render nicely. The problem was solved in the jwst pipeline, see a PR from Brett

CHANGES.rst Outdated Show resolved Hide resolved
docs/roman/outlier_detection/arguments.rst Show resolved Hide resolved
docs/roman/outlier_detection/arguments.rst Outdated Show resolved Hide resolved
docs/roman/outlier_detection/arguments.rst Show resolved Hide resolved
docs/roman/outlier_detection/outlier_detection.rst Outdated Show resolved Hide resolved
docs/roman/outlier_detection/outlier_detection.rst Outdated Show resolved Hide resolved
@mairanteodoro
Copy link
Collaborator Author

The spec section does not render nicely. The problem was solved in the jwst pipeline, see a PR from Brett

Done. Applied fix implemented in PR#8101.

@mairanteodoro mairanteodoro merged commit d3e0240 into spacetelescope:main Dec 19, 2023
28 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation pipeline
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants