Updated tutorials call to download test data + inclusion of RDI tutorial

VChristiaens · Oct 25, 2024 · f836b80 · f836b80
1 parent 185e35a
commit f836b80
Show file tree

Hide file tree

Showing 13 changed files with 11,325 additions and 11,876 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -50,6 +50,7 @@ a bug, ask a question, suggest a new functionality or contribute to the code (th
    tutorials/04_metrics
    tutorials/05A_fm_planets
    tutorials/05B_fm_disks
+   tutorials/06_psfsub_fm_RDI
    tutorials/07_psfsub_fm_IFS-ASDI_planets
    tutorials/08_imlib_and_interpolation
 

diff --git a/docs/source/tutorials/01A_quickstart.ipynb b/docs/source/tutorials/01A_quickstart.ipynb
@@ -105,8 +105,8 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "```{important}  \n",
-    "Your version of VIP should be >=1.0.3. If not, close the notebook and run for example `pip install vip_hci --upgrade` in your terminal.\n",
+    "```{warning}  \n",
+    "Your version of VIP should be >=1.0.3 to run this notebook. If not, close the notebook and run for example `pip install vip_hci --upgrade` in your terminal.\n",
     "```"
    ]
   },
@@ -261,7 +261,7 @@
    "metadata": {},
    "source": [
     "```{important}                                       \n",
-    "The *convention* in VIP is to always consider you are providing **derotation angles** as input, not **parallactic angles**. Derotation angles are the angles to be applied to the observed images (with positive offsets measured counter-clockwise) in order to align them with north up. These are essentially the *opposite* values of the parallactic angles plus some instrument-specific offsets. The additional offsets can correspond to any internal reflections affecting the orientation of the field of view, or to a correction for the true north orientation which may drift over time and requires dedicated instrumental calibrations. These additional offsets should be checked in the manual of the instrument you are using.\n",
+    "The *convention* in VIP is to consider **derotation angles** as input for ADI-based post-processing algorithms, not **parallactic angles**. Derotation angles are the angles to be applied to the observed images (with positive offsets measured counter-clockwise) in order to align them with north up. These are essentially the *opposite* values of the parallactic angles plus some instrument-specific offsets. The additional offsets can correspond to any internal reflections affecting the orientation of the field of view, or to a correction for the true north orientation which may drift over time and requires dedicated instrumental calibrations. These additional offsets should be checked in the manual of the instrument you are using.\n",
     "```"
    ]
   },

diff --git a/docs/source/tutorials/01B_quickstart_with_objects.ipynb b/docs/source/tutorials/01B_quickstart_with_objects.ipynb
@@ -112,7 +112,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "```{important}\n",
+    "```{warning}\n",
     "Your version of VIP should be >=1.4.2 to run this notebook. If not, close the notebook and run for example `pip install vip_hci --upgrade` in your terminal. Also make sure the Python version used is 3.10 or higher. \n",
     "```"
    ]
@@ -194,15 +194,15 @@
    "source": [
     "The fits file contains an ADI datacube of 61 images 101x101 px across.\n",
     "\n",
-    "The parallactic angle vector for this observation is saved in the `naco_betapic_pa.fits` file. "
+    "The derotation angle vector for this observation is saved in the `naco_betapic_derot_angles.fits` file. "
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
     "```{important}                                       \n",
-    "The *convention* in VIP is to always consider you are providing **derotation angles** as input, not **parallactic angles**. Derotation angles are the angles to be applied to the observed images (with positive offsets measured counter-clockwise) in order to align them with north up. These are essentially the *opposite* values of the parallactic angles plus some instrument-specific offsets. The additional offsets can correspond to any internal reflections affecting the orientation of the field of view, or to a correction for the true north orientation which may drift over time and requires dedicated instrumental calibrations. These additional offsets should be checked in the manual of the instrument you are using.\n",
+    "The *convention* in VIP is to consider **derotation angles** as input, not **parallactic angles**. Derotation angles are the angles to be applied to the observed images (with positive offsets measured counter-clockwise) in order to align them with north up. These are essentially the *opposite* values of the parallactic angles plus some instrument-specific offsets. The additional offsets can correspond to any internal reflections affecting the orientation of the field of view, or to a correction for the true north orientation which may drift over time and requires dedicated instrumental calibrations. These additional offsets should be checked in the manual of the instrument you are using.\n",
     "```"
    ]
   },

diff --git a/docs/source/tutorials/02_preproc.ipynb b/docs/source/tutorials/02_preproc.ipynb
diff --git a/docs/source/tutorials/03A_psfsub_ADI.ipynb b/docs/source/tutorials/03A_psfsub_ADI.ipynb