Update README.rst to include Cython to Python speed-up

xpsi-group · Dec 13, 2024 · f38fa9f · f38fa9f
1 parent 892040c
commit f38fa9f
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/README.rst b/README.rst
@@ -35,7 +35,7 @@ Installation and Testing
 
 NEoST is best installed from source. The documentation provides
 `step-by-step installation instructions <https://xpsi-group.github.io/neost/install.html>`_
-for Linux and for limited MacOS systems.
+for Linux and for limited MacOS systems. Note, NEoST offers two install options for the Tolman-Oppenheimer-Volkoff equation solvers: one using Cython and the other using Python. If one wishes to install using Python (e.g., due to incompatability with Cython and so the TOV solvers don't cythonize), we estimate the approximate speed-up of using Cython to Python to be at least 15x (if dark matter is turned on) and 20x (if dark matter is turned off).
 
 Documentation
 -------------