Package for astronomical high-contrast image processing.
--------------------------------------------------- oooooo oooo ooooo ooooooooo. `888. .8' `888' `888 `Y88. `888. .8' 888 888 .d88' `888. .8' 888 888ooo88P' `888.8' 888 888 `888' 888 888 `8' o888o o888o --------------------------------------------------- Vortex Image Processing package ---------------------------------------------------
VIP is a python package for angular, reference star and spectral differential imaging for exoplanet/disk detection through high-contrast imaging. VIP is compatible with Python 2.7, 3.6 and 3.7.
The goal of VIP is to incorporate open-source, efficient, easy-to-use and well-documented implementations of high-contrast image processing algorithms to the interested scientific community. The main repository of VIP resides on GitHub, the standard for scientific open source code distribution, using Git as a version control system.
VIP started as the effort of Carlos Alberto Gomez Gonzalez, a former PhD student of the VORTEX team (ULiege, Belgium). VIP’s development is led by C. Gomez with contributions made by collaborators from several teams (take a look at the contributors tab on VIP’s GitHub repository). Most of VIP’s functionalities are mature but it doesn’t mean it’s free from bugs. The code is continuously evolving and therefore feedback/contributions are greatly appreciated. If you want to report a bug or suggest a functionality please create an issue on GitHub. Pull requests are very welcomed!
The documentation for VIP can be found here: http://vip.readthedocs.io.
Jupyter notebook tutorial
A tutorial (Jupyter notebook) showing he use of VIP for ADI data processing is available in this repository. Alternatively, it can be visualized online here. If you are new to the Jupyter notebook application check out the beginner guide.
TL;DR setup guide
$ pip install vip_hci
Installation and dependencies
The benefits of using a Python package manager (distribution), such as (ana)conda or Canopy, are many. Mainly, it brings easy and robust package management and avoids messing up with your system’s default python. An alternative is to use package managers like apt-get for Ubuntu or Homebrew/MacPorts/Fink for macOS. I personally recommend using Miniconda.
VIP depends on existing packages from the Python ecosystem, such as numpy, scipy, matplotlib, pandas, astropy, scikit-learn, scikit-image, photutils and emcee. There are different ways of installing VIP suitable for different scenarios.
The easiest way to install VIP is through the Python Package Index, aka PyPI, with the pip package manager. Simply run:
$ pip install vip_hci
With pip you can easily uninstall, upgrade or install a specific version of VIP. For upgrading the package run:
$ pip install --upgrade vip_hci
Alternatively, you can use pip install and point to the GitHub repo:
$ pip install git+https://github.com/vortex-exoplanet/VIP.git
Using the setup.py file
You can download VIP from its GitHub repository as a zip file. A setup.py file (setuptools) is included in the root folder of VIP. Enter the package’s root folder and run:
$ python setup.py install
If you want to benefit from the git functionalities, you need to clone the repository (make sure your system has git installed):
$ git clone https://github.com/vortex-exoplanet/VIP.git
Then you can install the package by following the previous steps, using the setup.py file. Creating a fork with GitHub is recommended to developers or to users who want to experiment with the code.
OpenCV (Open source Computer Vision) provides fast C++ image processing operations and is used by VIP for basic image transformations. If you don’t have/want the OpenCV python bindings (OpenCV is optional since VIP v0.5.2), VIP will use the much slower ndimage/scikit-image libraries transparently. Fortunately, installing OpenCV library is nowadays and easy process that is done automatically with the VIP installation. Alternatively, you could use conda:
$ conda install opencv
VIP contains a class vip_hci.fits.ds9 that enables, through pyds9, the interaction with a DS9 window (displaying numpy arrays, controlling the display options, etc). pyds9 is an optional requirement and must be installed from the latest development version:
$ pip install git+git://github.com/ericmandel/pyds9.git#egg=pyds9
Also, you can install the Intel Math Kernel Library (MKL) optimizations (provided that you have a recent version of conda) or openblas libraries. Either of them can be installed with conda install. This is recommended along with OpenCV for maximum speed on VIP computations.
VIP offers the possibility of computing SVDs on GPU by using CuPy (starting from version 0.8.0) or PyTorch (from version 0.9.2). These remain as optional requirements, to be installed by the user, as well as a proper CUDA environment (and a decent GPU card).
Finally, start Python (or IPython or a Jupyter notebook if you prefer) and check that you are able to import VIP:
import vip_hci as vip
If everything went fine with the installation, you will see a welcome message. Now you can start finding exoplanets!
Please subscribe to our mailing list if you want to be informed of VIP’s latest developments (new versions and/or updates).
Please cite Gomez Gonzalez et al. 2017 (http://iopscience.iop.org/article/10.3847/1538-3881/aa73d7/) whenever you publish data reduced with VIP. Astrophysics Source Code Library reference [ascl:1603.003].