Merge pull request #375 from carlgogo/master

updating requirements and docs

docs/source/vip_hci.andromeda.rst

@@ -1,5 +1,5 @@
-vip\_hci\.andromeda package
-===========================
+vip\_hci.andromeda package
+==========================
 
 .. automodule:: vip_hci.andromeda
     :members:
@@ -9,32 +9,32 @@ vip\_hci\.andromeda package
 Submodules
 ----------
 
-vip\_hci\.andromeda\.andromeda module
--------------------------------------
+vip\_hci.andromeda.andromeda module
+-----------------------------------
 
 .. automodule:: vip_hci.andromeda.andromeda
     :members:
     :undoc-members:
     :show-inheritance:
 
-vip\_hci\.andromeda\.fit module
--------------------------------
+vip\_hci.andromeda.fit module
+-----------------------------
 
 .. automodule:: vip_hci.andromeda.fit
     :members:
     :undoc-members:
     :show-inheritance:
 
-vip\_hci\.andromeda\.shift module
----------------------------------
+vip\_hci.andromeda.shift module
+-------------------------------
 
 .. automodule:: vip_hci.andromeda.shift
     :members:
     :undoc-members:
     :show-inheritance:
 
-vip\_hci\.andromeda\.utils module
----------------------------------
+vip\_hci.andromeda.utils module
+-------------------------------
 
 .. automodule:: vip_hci.andromeda.utils
     :members:

docs/source/vip_hci.conf.rst

@@ -1,5 +1,5 @@
-vip\_hci\.conf package
-======================
+vip\_hci.conf package
+=====================
 
 .. automodule:: vip_hci.conf
     :members:
@@ -9,32 +9,32 @@ vip\_hci\.conf package
 Submodules
 ----------
 
-vip\_hci\.conf\.mem module
---------------------------
+vip\_hci.conf.mem module
+------------------------
 
 .. automodule:: vip_hci.conf.mem
     :members:
     :undoc-members:
     :show-inheritance:
 
-vip\_hci\.conf\.param module
-----------------------------
+vip\_hci.conf.param module
+--------------------------
 
 .. automodule:: vip_hci.conf.param
     :members:
     :undoc-members:
     :show-inheritance:
 
-vip\_hci\.conf\.timing module
------------------------------
+vip\_hci.conf.timing module
+---------------------------
 
 .. automodule:: vip_hci.conf.timing
     :members:
     :undoc-members:
     :show-inheritance:
 
-vip\_hci\.conf\.utils\_conf module
-----------------------------------
+vip\_hci.conf.utils\_conf module
+--------------------------------
 
 .. automodule:: vip_hci.conf.utils_conf
     :members:

docs/source/vip_hci.exlib.rst

@@ -1,5 +1,5 @@
-vip\_hci\.exlib package
-=======================
+vip\_hci.exlib package
+======================
 
 .. automodule:: vip_hci.exlib
     :members:
@@ -9,8 +9,8 @@ vip\_hci\.exlib package
 Submodules
 ----------
 
-vip\_hci\.exlib\.iuwt module
-----------------------------
+vip\_hci.exlib.iuwt module
+--------------------------
 
 .. automodule:: vip_hci.exlib.iuwt
     :members:

docs/source/vip_hci.fits.rst

@@ -1,5 +1,5 @@
-vip\_hci\.fits package
-======================
+vip\_hci.fits package
+=====================
 
 .. automodule:: vip_hci.fits
     :members:
@@ -9,8 +9,8 @@ vip\_hci\.fits package
 Submodules
 ----------
 
-vip\_hci\.fits\.fits module
----------------------------
+vip\_hci.fits.fits module
+-------------------------
 
 .. automodule:: vip_hci.fits.fits
     :members:

docs/source/vip_hci.frdiff.rst

@@ -1,5 +1,5 @@
-vip\_hci\.frdiff package
-========================
+vip\_hci.frdiff package
+=======================
 
 .. automodule:: vip_hci.frdiff
     :members:
@@ -9,8 +9,8 @@ vip\_hci\.frdiff package
 Submodules
 ----------
 
-vip\_hci\.frdiff\.framediff module
-----------------------------------
+vip\_hci.frdiff.framediff module
+--------------------------------
 
 .. automodule:: vip_hci.frdiff.framediff
     :members:

docs/source/vip_hci.leastsq.rst

@@ -1,5 +1,5 @@
-vip\_hci\.leastsq package
-=========================
+vip\_hci.leastsq package
+========================
 
 .. automodule:: vip_hci.leastsq
     :members:
@@ -9,8 +9,8 @@ vip\_hci\.leastsq package
 Submodules
 ----------
 
-vip\_hci\.leastsq\.leastsq module
----------------------------------
+vip\_hci.leastsq.leastsq module
+-------------------------------
 
 .. automodule:: vip_hci.leastsq.leastsq
     :members:

docs/source/vip_hci.llsg.rst

@@ -1,5 +1,5 @@
-vip\_hci\.llsg package
-======================
+vip\_hci.llsg package
+=====================
 
 .. automodule:: vip_hci.llsg
     :members:
@@ -9,16 +9,16 @@ vip\_hci\.llsg package
 Submodules
 ----------
 
-vip\_hci\.llsg\.llsg module
----------------------------
+vip\_hci.llsg.llsg module
+-------------------------
 
 .. automodule:: vip_hci.llsg.llsg
     :members:
     :undoc-members:
     :show-inheritance:
 
-vip\_hci\.llsg\.thresholding module
------------------------------------
+vip\_hci.llsg.thresholding module
+---------------------------------
 
 .. automodule:: vip_hci.llsg.thresholding
     :members:

docs/source/vip_hci.medsub.rst

@@ -1,5 +1,5 @@
-vip\_hci\.medsub package
-========================
+vip\_hci.medsub package
+=======================
 
 .. automodule:: vip_hci.medsub
     :members:
@@ -9,8 +9,8 @@ vip\_hci\.medsub package
 Submodules
 ----------
 
-vip\_hci\.medsub\.medsub\_source module
----------------------------------------
+vip\_hci.medsub.medsub\_source module
+-------------------------------------
 
 .. automodule:: vip_hci.medsub.medsub_source
     :members:

docs/source/vip_hci.metrics.rst

@@ -1,5 +1,5 @@
-vip\_hci\.metrics package
-=========================
+vip\_hci.metrics package
+========================
 
 .. automodule:: vip_hci.metrics
     :members:
@@ -9,84 +9,92 @@ vip\_hci\.metrics package
 Submodules
 ----------
 
-vip\_hci\.metrics\.contrcurve module
-------------------------------------
+vip\_hci.metrics.contrcurve module
+----------------------------------
 
 .. automodule:: vip_hci.metrics.contrcurve
     :members:
     :undoc-members:
     :show-inheritance:
 
-vip\_hci\.metrics\.detection module
------------------------------------
+vip\_hci.metrics.detection module
+---------------------------------
 
 .. automodule:: vip_hci.metrics.detection
     :members:
     :undoc-members:
     :show-inheritance:
 
-vip\_hci\.metrics\.dust\_distribution module
---------------------------------------------
+vip\_hci.metrics.dust\_distribution module
+------------------------------------------
 
 .. automodule:: vip_hci.metrics.dust_distribution
     :members:
     :undoc-members:
     :show-inheritance:
 
-vip\_hci\.metrics\.fakecomp module
-----------------------------------
+vip\_hci.metrics.fakecomp module
+--------------------------------
 
 .. automodule:: vip_hci.metrics.fakecomp
     :members:
     :undoc-members:
     :show-inheritance:
 
-vip\_hci\.metrics\.fakedisk module
-----------------------------------
+vip\_hci.metrics.fakedisk module
+--------------------------------
 
 .. automodule:: vip_hci.metrics.fakedisk
     :members:
     :undoc-members:
     :show-inheritance:
 
-vip\_hci\.metrics\.frame\_analysis module
------------------------------------------
+vip\_hci.metrics.frame\_analysis module
+---------------------------------------
 
 .. automodule:: vip_hci.metrics.frame_analysis
     :members:
     :undoc-members:
     :show-inheritance:
 
-vip\_hci\.metrics\.phase\_function module
------------------------------------------
+vip\_hci.metrics.phase\_function module
+---------------------------------------
 
 .. automodule:: vip_hci.metrics.phase_function
     :members:
     :undoc-members:
     :show-inheritance:
 
-vip\_hci\.metrics\.roc module
------------------------------
+vip\_hci.metrics.roc module
+---------------------------
 
 .. automodule:: vip_hci.metrics.roc
     :members:
     :undoc-members:
     :show-inheritance:
 
-vip\_hci\.metrics\.scattered\_light\_disk module
-------------------------------------------------
+vip\_hci.metrics.scattered\_light\_disk module
+----------------------------------------------
 
 .. automodule:: vip_hci.metrics.scattered_light_disk
     :members:
     :undoc-members:
     :show-inheritance:
 
-vip\_hci\.metrics\.snr module
------------------------------
+vip\_hci.metrics.snr module
+---------------------------
 
 .. automodule:: vip_hci.metrics.snr
     :members:
     :undoc-members:
     :show-inheritance:
 
+vip\_hci.metrics.stim module
+----------------------------
+
+.. automodule:: vip_hci.metrics.stim
+    :members:
+    :undoc-members:
+    :show-inheritance:
+