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

JP-3342: Reorganize outlier detection documentation #8880

Merged
merged 13 commits into from
Oct 22, 2024

Conversation

emolter
Copy link
Collaborator

@emolter emolter commented Oct 11, 2024

Resolves JP-3342

Closes #7817

This PR reorganizes the outlier detection documentation to improve clarity, and to remove lots of outdated information. While this ticket has been associated with additional refactoring of the outlier detection step (including splitting it into multiple steps mode-by-mode), I found that the majority of documentation updates were possible without any code refactoring. These updates are intended to anticipate that refactoring such that only minor changes will be needed once that occurs.

Tasks

  • request a review from someone specific, to avoid making the maintainers review every PR
  • add a build milestone, i.e. Build 11.3 (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#>.datamodels.rst
  • changes/<PR#>.scripts.rst
  • changes/<PR#>.fits_generator.rst
  • changes/<PR#>.set_telescope_pointing.rst
  • changes/<PR#>.pipeline.rst

stage 1

  • changes/<PR#>.group_scale.rst
  • changes/<PR#>.dq_init.rst
  • changes/<PR#>.emicorr.rst
  • changes/<PR#>.saturation.rst
  • changes/<PR#>.ipc.rst
  • changes/<PR#>.firstframe.rst
  • changes/<PR#>.lastframe.rst
  • changes/<PR#>.reset.rst
  • changes/<PR#>.superbias.rst
  • changes/<PR#>.refpix.rst
  • changes/<PR#>.linearity.rst
  • changes/<PR#>.rscd.rst
  • changes/<PR#>.persistence.rst
  • changes/<PR#>.dark_current.rst
  • changes/<PR#>.charge_migration.rst
  • changes/<PR#>.jump.rst
  • changes/<PR#>.clean_flicker_noise.rst
  • changes/<PR#>.ramp_fitting.rst
  • changes/<PR#>.gain_scale.rst

stage 2

  • changes/<PR#>.assign_wcs.rst
  • changes/<PR#>.badpix_selfcal.rst
  • changes/<PR#>.msaflagopen.rst
  • changes/<PR#>.nsclean.rst
  • changes/<PR#>.imprint.rst
  • changes/<PR#>.background.rst
  • changes/<PR#>.extract_2d.rst
  • changes/<PR#>.master_background.rst
  • changes/<PR#>.wavecorr.rst
  • changes/<PR#>.srctype.rst
  • changes/<PR#>.straylight.rst
  • changes/<PR#>.wfss_contam.rst
  • changes/<PR#>.flatfield.rst
  • changes/<PR#>.fringe.rst
  • changes/<PR#>.pathloss.rst
  • changes/<PR#>.barshadow.rst
  • changes/<PR#>.photom.rst
  • changes/<PR#>.pixel_replace.rst
  • changes/<PR#>.resample_spec.rst
  • changes/<PR#>.residual_fringe.rst
  • changes/<PR#>.cube_build.rst
  • changes/<PR#>.extract_1d.rst
  • changes/<PR#>.resample.rst

stage 3

  • changes/<PR#>.assign_mtwcs.rst
  • changes/<PR#>.mrs_imatch.rst
  • changes/<PR#>.tweakreg.rst
  • changes/<PR#>.skymatch.rst
  • changes/<PR#>.exp_to_source.rst
  • changes/<PR#>.outlier_detection.rst
  • changes/<PR#>.tso_photometry.rst
  • changes/<PR#>.stack_refs.rst
  • changes/<PR#>.align_refs.rst
  • changes/<PR#>.klip.rst
  • changes/<PR#>.spectral_leak.rst
  • changes/<PR#>.source_catalog.rst
  • changes/<PR#>.combine_1d.rst
  • changes/<PR#>.ami.rst

other

  • changes/<PR#>.wfs_combine.rst
  • changes/<PR#>.white_light.rst
  • changes/<PR#>.cube_skymatch.rst
  • changes/<PR#>.engdb_tools.rst
  • changes/<PR#>.guider_cds.rst

Copy link

codecov bot commented Oct 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 61.85%. Comparing base (19f7809) to head (5653c9d).
Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #8880   +/-   ##
=======================================
  Coverage   61.85%   61.85%           
=======================================
  Files         377      377           
  Lines       38877    38877           
=======================================
  Hits        24046    24046           
  Misses      14831    14831           

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

@emolter emolter added this to the Build 11.2 milestone Oct 11, 2024
@emolter emolter marked this pull request as ready for review October 11, 2024 18:30
@emolter emolter requested a review from a team as a code owner October 11, 2024 18:30
Copy link
Collaborator

@jemorrison jemorrison left a comment

Choose a reason for hiding this comment

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

The documentation is much clearer now.

docs/jwst/outlier_detection/arguments.rst Show resolved Hide resolved
Copy link
Collaborator

@melanieclarke melanieclarke left a comment

Choose a reason for hiding this comment

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

This looks great! I especially like the reorganization of the arguments page - it's much easier to figure out now.

Mostly nitpicky copy edits below, but a couple substantive suggestions.

docs/jwst/outlier_detection/reference_files.rst Outdated Show resolved Hide resolved
docs/jwst/outlier_detection/main.rst Show resolved Hide resolved
docs/jwst/outlier_detection/main.rst Outdated Show resolved Hide resolved
docs/jwst/outlier_detection/main.rst Outdated Show resolved Hide resolved
docs/jwst/outlier_detection/main.rst Outdated Show resolved Hide resolved
docs/jwst/outlier_detection/outlier_detection_ifu.rst Outdated Show resolved Hide resolved
docs/jwst/outlier_detection/outlier_detection_ifu.rst Outdated Show resolved Hide resolved
docs/jwst/outlier_detection/outlier_detection_ifu.rst Outdated Show resolved Hide resolved
docs/jwst/outlier_detection/outlier_detection_ifu.rst Outdated Show resolved Hide resolved
docs/jwst/outlier_detection/main.rst Outdated Show resolved Hide resolved
@emolter emolter requested a review from melanieclarke October 21, 2024 17:12
Copy link
Collaborator

@melanieclarke melanieclarke left a comment

Choose a reason for hiding this comment

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

Thanks for all the updates! I think this looks good now. I have two very small follow up comments for clarity and consistency, but I will approve now.

docs/jwst/outlier_detection/reference_files.rst Outdated Show resolved Hide resolved
jwst/outlier_detection/outlier_detection_step.py Outdated Show resolved Hide resolved
@emolter emolter enabled auto-merge (squash) October 22, 2024 14:57
@emolter emolter merged commit 3be9992 into spacetelescope:main Oct 22, 2024
31 checks passed
@emolter emolter deleted the JP-3342 branch October 22, 2024 15:28
hayescr pushed a commit to hayescr/jwst that referenced this pull request Oct 29, 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.

Add documentation for outlier_detection
3 participants