From 7f38c3cd1ef5b59a2d5de453f0ff9204821cd70f Mon Sep 17 00:00:00 2001 From: VChristiaens Date: Fri, 18 Mar 2022 11:53:40 +0100 Subject: [PATCH 1/5] Typo fixes in readme --- README.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.rst b/README.rst index eaa61493..7b477b1e 100644 --- a/README.rst +++ b/README.rst @@ -191,7 +191,6 @@ also install the optional dependencies listed below. Optional dependencies ^^^^^^^^^^^^^^^^^^^^^ - The following dependencies are not automatically installed upon installation of ``VIP`` but may significantly improve your experience: @@ -265,4 +264,4 @@ In addition, if you use one of the following modules, please also cite: - pca: `Amara and Quanz (2012) `_ and `Soummer et al. (2012) `_; -Note: The `specfit `_ module, previously part of VIP, has now been moved to a separate GitHub repository. +Note: The ``specfit`` module, previously part of VIP, has now been moved to a separate `GitHub repository `_. From d22c90eda6ed413a39dae4cc83528ee608d34ab9 Mon Sep 17 00:00:00 2001 From: VChristiaens Date: Fri, 18 Mar 2022 11:56:27 +0100 Subject: [PATCH 2/5] Typo fixes in readme --- README.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 7b477b1e..95ca4740 100644 --- a/README.rst +++ b/README.rst @@ -191,8 +191,7 @@ also install the optional dependencies listed below. Optional dependencies ^^^^^^^^^^^^^^^^^^^^^ -The following dependencies are not automatically installed upon installation of - ``VIP`` but may significantly improve your experience: +The following dependencies are not automatically installed upon installation of ``VIP`` but may significantly improve your experience: ``VIP`` contains a class ``vip_hci.fits.ds9`` that enables, through ``pyds9``, the interaction with a DS9 window (displaying numpy arrays, controlling the From 585ae60a38f0328a858e0782658266ceef0699ef Mon Sep 17 00:00:00 2001 From: VChristiaens Date: Fri, 18 Mar 2022 11:58:21 +0100 Subject: [PATCH 3/5] Made optional dependencies as list in readme --- README.rst | 17 +++++------------ 1 file changed, 5 insertions(+), 12 deletions(-) diff --git a/README.rst b/README.rst index 95ca4740..2cfd8ee8 100644 --- a/README.rst +++ b/README.rst @@ -193,26 +193,19 @@ Optional dependencies ^^^^^^^^^^^^^^^^^^^^^ The following dependencies are not automatically installed upon installation of ``VIP`` but may significantly improve your experience: -``VIP`` contains a class ``vip_hci.fits.ds9`` that enables, through ``pyds9``, +- ``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: - -.. code-block:: bash - - $ pip install git+git://github.com/ericmandel/pyds9.git#egg=pyds9 - -Also, you can install the Intel Math Kernel Library (``mkl``) optimizations +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`` +- ``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, bad pixel correction routines can be optimised with ``Numba``, which +- Finally, bad pixel correction routines can be optimised with ``Numba``, which converts some Python code, particularly ``NumPy``, into fast machine code. A factor up to ~50x times speed improvement can be obtained on large images compared to NumPy. Numba can be installed with ``conda install numba``. From 04775bf1c37eafcf9779e3d19ce05376557a9024 Mon Sep 17 00:00:00 2001 From: VChristiaens Date: Fri, 18 Mar 2022 11:59:07 +0100 Subject: [PATCH 4/5] Made optional dependencies as list in readme --- README.rst | 20 ++++---------------- 1 file changed, 4 insertions(+), 16 deletions(-) diff --git a/README.rst b/README.rst index 2cfd8ee8..c9fbba72 100644 --- a/README.rst +++ b/README.rst @@ -193,22 +193,10 @@ Optional dependencies ^^^^^^^^^^^^^^^^^^^^^ The following dependencies are not automatically installed upon installation of ``VIP`` but may significantly improve your experience: -- ``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, bad pixel correction routines can be optimised with ``Numba``, which -converts some Python code, particularly ``NumPy``, into fast machine code. A -factor up to ~50x times speed improvement can be obtained on large images -compared to NumPy. Numba can be installed with ``conda install numba``. +- ``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, bad pixel correction routines can be optimised with ``Numba``, which converts some Python code, particularly ``NumPy``, into fast machine code. A factor up to ~50x times speed improvement can be obtained on large images compared to NumPy. Numba can be installed with ``conda install numba``. Loading VIP From cbde04652b385edd1c41ca5edcbb4e52e0216eb4 Mon Sep 17 00:00:00 2001 From: VChristiaens Date: Fri, 18 Mar 2022 12:01:09 +0100 Subject: [PATCH 5/5] Made optional dependencies as list in readme --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index c9fbba72..c1fcf3af 100644 --- a/README.rst +++ b/README.rst @@ -193,7 +193,7 @@ Optional dependencies ^^^^^^^^^^^^^^^^^^^^^ The following dependencies are not automatically installed upon installation of ``VIP`` but may significantly improve your experience: -- ``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`` +- ``VIP`` contains a class ``vip_hci.vip_ds9`` that enables, through ``pyds9``, the interaction with a DS9 window (displaying numpy arrays, controlling the display options, etc). To enable this feature, ``pyds9`` 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, bad pixel correction routines can be optimised with ``Numba``, which converts some Python code, particularly ``NumPy``, into fast machine code. A factor up to ~50x times speed improvement can be obtained on large images compared to NumPy. Numba can be installed with ``conda install numba``.