Running the tutorials

Tutorials in the form of Jupyter notebooks and showcasing VIP’s usage can be visualised within this documentation. In order to execute the notebook tutorials, you will have to download or clone the VIP-extras repository, and open each tutorial locally with jupyter notebook. The VIP-extras repository is available here. Alternatively, you can execute these tutorials on Binder.

If you are new to the Jupyter notebook application check out the beginner’s guide.

For notebooks 1 and 3, an object-oriented version is available, leveraging new Dataset and Post-processing algorithm Classes. Note that these tutorials (1B and 3B) will only run for Python versions 3.10 or later.

A summary of available notebooks is provided below:

  • Tutorial 1A: Quick-start tutorial showcasing basic usage;

  • Tutorial 1B: Quickstart with VIP’s object-oriented framework;

  • Tutorial 2: pre-processing functionalities available in VIP (star centering, bad frame trimming, bad pixel correction, etc.);

  • Tutorial 3A: example usage for all ADI-based post-processing algorithms implemented in VIP;

  • Tutorial 3B: Same as above with the object-oriented framework;

  • Tutorial 4: metrics to evaluate the significance of a detection or the achieved contrast in your images;

  • Tutorial 5A: how to characterize a directly imaged companion;

  • Tutorial 5B: how to characterize a circumstellar disk;

  • Tutorial 5C (coming soon): how to characterize a companion in a disk using JWST observations ;

  • Tutorial 6: post-processing algorithms leveraging reference star differential imaging;

  • Tutorial 7:

post-processing algorithms leveraging spectral differential imaging; - Tutorial 8: the difference between FFT- and interpolation-based image operations (rotation, shifts, scaling).