Add note about SuperBiasStep workaround to tutorial notebooks

radicamc · Jul 25, 2024 · eb3e8b9 · eb3e8b9
1 parent 41022f2
commit eb3e8b9
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/docs/content/notebooks/tutorial_niriss-soss.ipynb b/docs/content/notebooks/tutorial_niriss-soss.ipynb
@@ -271,6 +271,17 @@
     "Now we subtract the superbias level from all frames.  "
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "<div class=\"alert alert-block alert-info\"> <b>NOTE:</b> When running the Superbias Correction with the direct outputs of a previous step a specific error may occur: <br>\n",
+    "   <code>UFuncTypeError: Cannot cast ufunc 'subtract' output from dtype('float32') to dtype('uint16') with casting rule 'same_kind'. </code> <br>\n",
+    "This likely stems from a crds reference file compatability issue, and is being looked into. In the mean time, a workaround is to simply create a list of paths to the previous step output files, e.g., <br>\n",
+    "    <code> results = ['XXXX_seg001_saturationstep.fits', 'XXXX_seg002_saturationstep.fits', ...]</code> <br>  \n",
+    "and pass this to the SuperBiasStep.</div>"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,

diff --git a/docs/content/notebooks/tutorial_nirspec-g395h.ipynb b/docs/content/notebooks/tutorial_nirspec-g395h.ipynb
@@ -300,6 +300,17 @@
     "Now we subtract the superbias level from all frames.  "
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "<div class=\"alert alert-block alert-info\"> <b>NOTE:</b> When running the Superbias Correction with the direct outputs of a previous step a specific error may occur: <br>\n",
+    "   <code>UFuncTypeError: Cannot cast ufunc 'subtract' output from dtype('float32') to dtype('uint16') with casting rule 'same_kind'. </code> <br>\n",
+    "This likely stems from a crds reference file compatability issue, and is being looked into. In the mean time, a workaround is to simply create a list of paths to the previous step output files, e.g., <br>\n",
+    "    <code> results = ['XXXX_seg001_saturationstep.fits', 'XXXX_seg002_saturationstep.fits', ...]</code> <br>  \n",
+    "and pass this to the SuperBiasStep.</div>"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,