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

Adding links to ramp fitting docs for roman and jwst in rampviz #3301

Merged
merged 6 commits into from
Nov 21, 2024

Conversation

bmorris3
Copy link
Contributor

@bmorris3 bmorris3 commented Nov 18, 2024

Description

Rampviz does a quick-look ramp extraction which does not make data quality classifications, or fit ramps, or correct for detector effects/defects. This PR adds notes on these caveats to the Ramp Extraction plugin and the Ramp Extraction section of the docs.

Here's a preview of the new docs section:

Screenshot 2024-11-18 at 10 26 34

Here's a preview of the new text and links in the plugin:

Screenshot 2024-11-18 at 11 18 32

Change log entry

  • Is a change log needed? If yes, is it added to CHANGES.rst? If you want to avoid merge conflicts,
    list the proposed change log here for review and add to CHANGES.rst before merge. If no, maintainer
    should add a no-changelog-entry-needed label.

Checklist for package maintainer(s)

This checklist is meant to remind the package maintainer(s) who will review this pull request of some common things to look for. This list is not exhaustive.

  • Are two approvals required? Branch protection rule does not check for the second approval. If a second approval is not necessary, please apply the trivial label.
  • Do the proposed changes actually accomplish desired goals? Also manually run the affected example notebooks, if necessary.
  • Do the proposed changes follow the STScI Style Guides?
  • Are tests added/updated as required? If so, do they follow the STScI Style Guides?
  • Are docs added/updated as required? If so, do they follow the STScI Style Guides?
  • Did the CI pass? If not, are the failures related?
  • Is a milestone set? Set this to bugfix milestone if this is a bug fix and needs to be released ASAP; otherwise, set this to the next major release milestone. Bugfix milestone also needs an accompanying backport label.
  • After merge, any internal documentations need updating (e.g., JIRA, Innerspace)? 🐱

@bmorris3 bmorris3 added documentation Explanation of code and concepts trivial Only needs one approval instead of two no-changelog-entry-needed changelog bot directive backport-v4.0.x on-merge: backport to v4.0.x labels Nov 18, 2024
@bmorris3 bmorris3 added this to the 4.0.1 milestone Nov 18, 2024
@github-actions github-actions bot added plugin Label for plugins common to multiple configurations rampviz labels Nov 18, 2024
Copy link

codecov bot commented Nov 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.81%. Comparing base (0858f95) to head (ae970a5).
Report is 30 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3301      +/-   ##
==========================================
+ Coverage   88.78%   88.81%   +0.02%     
==========================================
  Files         125      125              
  Lines       18832    19036     +204     
==========================================
+ Hits        16720    16906     +186     
- Misses       2112     2130      +18     

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


🚨 Try these New Features:

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@kecnry – is this ok for you? This removes the line break after the div, but also removes the top margin.

Copy link
Member

Choose a reason for hiding this comment

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

how does it look everywhere else that we use it? If those look ok, then great, otherwise we might want a toggle (can also have dynamic styling on the div to force in the same line).

docs/rampviz/plugins.rst Outdated Show resolved Hide resolved
docs/rampviz/plugins.rst Outdated Show resolved Hide resolved
docs/rampviz/plugins.rst Outdated Show resolved Hide resolved

Data products from infrared detectors flow through the official
`JWST <https://jwst-pipeline.readthedocs.io/en/latest/>`_ or
`Roman <https://roman-pipeline.readthedocs.io/en/latest/>`_ mission pipelines in levels. Infrared detectors use
Copy link
Contributor

Choose a reason for hiding this comment

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

Ideally this should also be using :ref: but I cannot find a good place to do it where it exist already. Might need to add one upstream or maybe use :doc: as you have.

Copy link
Contributor

Choose a reason for hiding this comment

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

docs/rampviz/plugins.rst Outdated Show resolved Hide resolved
bmorris3 and others added 3 commits November 19, 2024 09:44
Co-authored-by: P. L. Lim <2090236+pllim@users.noreply.github.com>
Co-authored-by: P. L. Lim <2090236+pllim@users.noreply.github.com>
Co-authored-by: P. L. Lim <2090236+pllim@users.noreply.github.com>
Copy link
Contributor

@pllim pllim left a comment

Choose a reason for hiding this comment

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

Good enough for now. Thx.

@bmorris3 bmorris3 merged commit 6986593 into spacetelescope:main Nov 21, 2024
19 checks passed
meeseeksmachine pushed a commit to meeseeksmachine/jdaviz that referenced this pull request Nov 21, 2024
pllim added a commit that referenced this pull request Nov 21, 2024
…1-on-v4.0.x

Backport PR #3301 on branch v4.0.x (Adding links to ramp fitting docs for roman and jwst in rampviz)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-v4.0.x on-merge: backport to v4.0.x documentation Explanation of code and concepts no-changelog-entry-needed changelog bot directive plugin Label for plugins common to multiple configurations rampviz trivial Only needs one approval instead of two
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants