Merge pull request #3301 from bmorris3/rampviz-docs-links

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

docs/conf.py

@@ -292,7 +292,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']

docs/rampviz/plugins.rst

@@ -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
+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.

jdaviz/components/external_link.vue

@@ -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>

jdaviz/configs/rampviz/plugins/ramp_extraction/ramp_extraction.vue

@@ -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}}.