Merge pull request #506 from VChristiaens/master

Updated contact info and docs, and fixed bug in helper function converting readme into do

README.rst

@@ -224,7 +224,8 @@ i.e. exactly on a pixel in either cases. The VIP recentering routines will place
 Contact
 -------
 Answers to `frequently asked questions <https://vip.readthedocs.io/en/latest/faq.html>`_ are provided in the relevant section of the documentation.
-If you find a bug or issue in VIP, it is recommended to post a new entry in the `Issues section <https://github.com/vortex-exoplanet/VIP/issues>`_ on GitHub. Feel free to propose a pull request if you have already identified the source of the issue.
+If you have an issue with VIP, please first check it is not detailed in the FAQ.
+If you find a bug or experience an unreported issue in VIP, it is recommended to post a new entry in the `Issues section <https://github.com/vortex-exoplanet/VIP/issues>`_ on GitHub. Feel free to propose a pull request if you have already identified the source of the bug/issue.
 
 If you have a global comment, enquiry about how to solve a specific task using VIP, or suggestions to improve VIP, feel free to open a new thread in the `Discussions <https://github.com/vortex-exoplanet/VIP/discussions>`_ section. The 'Discussions' section is also used to post new updates and discuss recent/on-going changes in VIP.
 Envisioned future developments are listed in the `Projects <https://github.com/vortex-exoplanet/VIP/projects/1>`_ section. Contributions are very welcome!
@@ -241,4 +242,4 @@ you publish data reduced with ``VIP`` . Astrophysics Source Code Library referen
 In addition, please cite the relevant publication(s) for the algorithms you use within VIP (usually mentioned in the documentation, e.g. `Marois et al. 2006 <https://ui.adsabs.harvard.edu/abs/2006ApJ...641..556M/abstract>`_ for median-ADI).
 
 
-Note: The ``specfit`` module, previously part of VIP, has now been moved to a separate `GitHub repository <https://github.com/VChristiaens/special>`_.
+Note: The ``specfit`` module, previously part of VIP, has now been renamed and moved to a separate `GitHub repository <https://github.com/VChristiaens/special>`_.

docs/source/Attribution.rst

@@ -5,4 +5,4 @@ you publish data reduced with ``VIP`` . Astrophysics Source Code Library referen
 In addition, please cite the relevant publication(s) for the algorithms you use within VIP (usually mentioned in the documentation, e.g. `Marois et al. 2006 <https://ui.adsabs.harvard.edu/abs/2006ApJ...641..556M/abstract>`_ for median-ADI).
 
 
-Note: The ``specfit`` module, previously part of VIP, has now been moved to a separate `GitHub repository <https://github.com/VChristiaens/special>`_.
+Note: The ``specfit`` module, previously part of VIP, has now been renamed and moved to a separate `GitHub repository <https://github.com/VChristiaens/special>`_.

docs/source/Contact.rst

@@ -1,7 +1,8 @@
 Contact
 -------
 Answers to `frequently asked questions <https://vip.readthedocs.io/en/latest/faq.html>`_ are provided in the relevant section of the documentation.
-If you find a bug or issue in VIP, it is recommended to post a new entry in the `Issues section <https://github.com/vortex-exoplanet/VIP/issues>`_ on GitHub. Feel free to propose a pull request if you have already identified the source of the issue.
+If you have an issue with VIP, please first check it is not detailed in the FAQ.
+If you find a bug or experience an unreported issue in VIP, it is recommended to post a new entry in the `Issues section <https://github.com/vortex-exoplanet/VIP/issues>`_ on GitHub. Feel free to propose a pull request if you have already identified the source of the bug/issue.
 
 If you have a global comment, enquiry about how to solve a specific task using VIP, or suggestions to improve VIP, feel free to open a new thread in the `Discussions <https://github.com/vortex-exoplanet/VIP/discussions>`_ section. The 'Discussions' section is also used to post new updates and discuss recent/on-going changes in VIP.
 Envisioned future developments are listed in the `Projects <https://github.com/vortex-exoplanet/VIP/projects/1>`_ section. Contributions are very welcome!

docs/source/Image-conventions.rst

@@ -0,0 +1,11 @@
+Image conventions
+-----------------
+
+By default, VIP routines are compatible with either even- or odd-dimension input frames. For VIP routines that require the star to be centered in the input images (e.g. post-processing routines involving (de)rotation or scaling), the code will assume that it is placed on (zero-based indexing):
+
+- size/2-0.5 for odd-size input images; 
+- size/2 for even-size input images;
+
+i.e. exactly on a pixel in either cases. The VIP recentering routines will place the star centroid at one of these locations accordingly.
+
+

docs/source/faq.rst

@@ -1,9 +1,6 @@
 Frequently asked questions
 --------------------------
 
-Check out the FAQ if you encounter problems when installing or running ``VIP``
-for the first time.
-
 Before skimming this list, please make sure you have the latest version of ``VIP``.
 Please go and check the repository now. Alternatively, you can run:
 

helpers/update_docs_rst_from_README.py

@@ -33,7 +33,7 @@
                 if occ > titles_occ[i]:
                     f_i.write(line)
                     start_write=True
-            elif str_titles[i+1] in line:
+            elif str_titles[i+1] in line and occ > titles_occ[i]:
                 stop_write=True
             else:
                 continue