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.

Sign up for GitHub

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
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
67cc0e9
adding links to ramp fitting docs for roman and jwst in rampviz
bmorris3 Nov 18, 2024
e12672e
switch to j-external-link rather than direct html links
bmorris3 Nov 18, 2024
7c3d1c3
link to stable rather than latest, use intersphinx
bmorris3 Nov 18, 2024
82f1168
Update docs/rampviz/plugins.rst
bmorris3 Nov 19, 2024
44d0552
Update docs/rampviz/plugins.rst
bmorris3 Nov 19, 2024
ae970a5
Update docs/rampviz/plugins.rst
bmorris3 Nov 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,10 @@
'specreduce': ('https://specreduce.readthedocs.io/en/stable/', None),
'specutils': ('https://specutils.readthedocs.io/en/stable/', None),
'stdatamodels': ('https://stdatamodels.readthedocs.io/en/latest/', None),
'traitlets': ('https://traitlets.readthedocs.io/en/stable/', None)})
'traitlets': ('https://traitlets.readthedocs.io/en/stable/', None),
'jwst': ('https://jwst-pipeline.readthedocs.io/en/stable/', None),
'romancal': ('https://roman-pipeline.readthedocs.io/en/stable/', None),
})

# Options for linkcheck
linkcheck_ignore = ['https://github.com/spacetelescope/jdaviz/settings/branches']
17 changes: 14 additions & 3 deletions docs/rampviz/plugins.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,17 @@ Slice
Ramp Extraction
===============

Coming soon.


Extract a ramp from a ramp cube.

Data products from infrared detectors flow through the official
:ref:`JWST <jwst:user-docs>` 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.

xref spacetelescope/romancal#1529

an "up-the-ramp" readout pattern, which is summarized in the
`JWST documentation <https://jwst-docs.stsci.edu/understanding-exposure-times>`_.

The Ramp Extraction plugin is a quick-look tool, and it does not support all of the features of the mission pipelines.
The mission pipelines produce rate images from ramp cubes by fitting the samples up the ramp while accounting for
non-linearity, jumps detected during an integration, saturation, and detector defects. These data quality checks and
corrections are not applied in the Ramp Extraction plugin. For details on how rate images are derived from ramps, see
the JWST pipeline's :ref:`jwst:ramp_fitting_step` step or the Roman pipeline's
:ref:`romancal:ramp_fitting_step` step.
10 changes: 4 additions & 6 deletions jdaviz/components/external_link.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
<template>
<div style="margin-top: 4px">
<a :href="link" target="__blank" style="color: #A75000">
<b>{{ linktext || "Learn More" }}</b>
<v-icon x-small color="#A75000">mdi-open-in-new</v-icon>
</a>
</div>
<a :href="link" target="__blank" style="color: #A75000">
<b>{{ linktext || "Learn More" }}</b>
<v-icon x-small color="#A75000">mdi-open-in-new</v-icon>
</a>
</template>

<script>
Expand Down
11 changes: 11 additions & 0 deletions jdaviz/configs/rampviz/plugins/ramp_extraction/ramp_extraction.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,17 @@
<div @mouseover="() => active_step='extract'">
<j-plugin-section-header :active="active_step==='extract'">Extract</j-plugin-section-header>

<v-row>
<span class="v-messages v-messages__message text--secondary">
Note: this plugin does not detecting defects in ramps, fit the ramps, or apply corrections. For details on
how rate images are derived from ramps, see the documentation for the
<j-external-link link='https://roman-pipeline.readthedocs.io/en/stable/roman/ramp_fitting/index.html' linktext='Roman pipeline'>
</j-external-link> or the
<j-external-link link='https://jwst-pipeline.readthedocs.io/en/stable/jwst/ramp_fitting/index.html#ramp-fitting-step' linktext='JWST pipeline'>
</j-external-link>.
</span>
</v-row>

<v-row v-if="aperture_selected !== 'None' && !aperture_selected_validity.is_aperture">
<span class="v-messages v-messages__message text--secondary">
Aperture: '{{aperture_selected}}' does not support subpixel: {{aperture_selected_validity.aperture_message}}.
Expand Down