Merge pull request #67 from xpsi-group/Documentation-updates

Documentation updates to clarify cython support for MAC M-series

docs/source/install.rst

@@ -93,7 +93,9 @@ To install NEoST itself, see Installing NEoST below.
 Installing on MAC M-series chips (arm-64)
 -----------------------------------------
 
-Errors may occur when installing MultiNest/PyMultiNest on MAC M-series chips as there are no arm-64 coda builds for `MultiNest <https://anaconda.org/conda-forge/multinest>`_. Although we do not have any definite solutions, we can offer a possible troubleshooting method that has worked in the past.
+Currently, the NEoST code doest not offer Cython support for MAC M-series chips (arm-64), thus the Cython TOV solvers will not work upon installation. So we please ask MAC M-series chip users to install NEoST without cythonizing (see the last paragraph at the end of the Install NEoST section). However, we are currently looking into this issue so that the Cython TOV solvers are available to all users. Until then, only the Python TOV solvers will be functional for MAC M-series chip users. 
+
+Errors may also occur when installing MultiNest/PyMultiNest on MAC M-series chips as there are no arm-64 coda builds for `MultiNest <https://anaconda.org/conda-forge/multinest>`_. Although we do not have any definite solutions, we can offer a possible troubleshooting method that has worked in the past.
 
 The first step is to remove PyMultiNest from the enviroment.yml file and re-run
 

docs/source/todo.rst

@@ -6,5 +6,6 @@ Future
 If there is a feature you would like to see that is not currently
 implemented in the package please let us know!  We are currently working on the following upgrades:
 
+* Ensuring that Cython is supported for MAC M-series NEoST users.
 * Adding the facility to use information from EM counterparts of GW events (as done in `Raaijmakers et al. 2021 <https://ui.adsabs.harvard.edu/abs/2021ApJ...918L..29R/abstract>`_).
 * Linking to alternative samplers.