You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: doc/source/installation.rst
+35-17
Original file line number
Diff line number
Diff line change
@@ -21,11 +21,15 @@ TL;DR
21
21
22
22
.. tab-item:: Mac
23
23
24
-
The recommended way to install is using ``pip``::
24
+
The recommended way to install in non-``conda`` environments (e.g., ``venv``) is using ``pip``::
25
25
26
26
python -m pip install --only-binary galpy galpy
27
27
28
-
This should install a fully-working version of galpy for Python versions >=3.8. If this fails, please open an `issue <https://github.com/jobovy/galpy/issues/new?assignees=&labels=&template=bug_report.md&title=>`__ on the ``galpy`` GitHub page, making sure to specify your platform and Python version. Then read on at :ref:`detailed_installation` to learn how to install ``galpy`` when the above fails.
28
+
If you are using ``conda``, especially if you used it to install ``numpy``, the recommended way to install is using ``conda``::
29
+
30
+
conda install -c conda-forge gsl galpy
31
+
32
+
These should install a fully-working version of galpy for Python versions >=3.8. If this fails, please open an `issue <https://github.com/jobovy/galpy/issues/new?assignees=&labels=&template=bug_report.md&title=>`__ on the ``galpy`` GitHub page, making sure to specify your platform and Python version. Then read on at :ref:`detailed_installation` to learn how to install ``galpy`` when the above fails.
29
33
30
34
.. tab-item:: Windows
31
35
@@ -140,25 +144,41 @@ If you are reading this, either the simple installation instructions at the top
140
144
141
145
python -m pip install --only-binary galpy galpy
142
146
143
-
Alternatively, you can install both the GSL and ``galpy`` using ``conda``::
147
+
However, if you are using ``conda`` and, particularly, if you used it to install
148
+
``numpy``, issues can arise with multiple OpenMP runtimes and the best way to
149
+
avoid those is to install using ``conda``::
144
150
145
151
conda install -c conda-forge gsl galpy
146
152
147
-
To compile ``galpy`` from source, you will first need to install the GSL. The
148
-
easiest way to do this is using `Homebrew <http://brew.sh/>`__ as::
153
+
To compile ``galpy`` from source, you will first need to install the GSL and OpenMP.
154
+
The easiest way to do this is using `Homebrew <http://brew.sh/>`__ as::
149
155
150
-
brew install gsl
156
+
brew install gsl libomp
151
157
152
-
Alternatively, you can use ``conda`` to install the GSL and use ``conda`` to
153
-
manage your Python environment. Install the GSL in your preferred environment
154
-
with::
158
+
Note that in order not to conflict with other OpenMP installations, the
159
+
``Homebrew`` version of ``libomp`` is "keg-only" and you have to set the
160
+
environment variables to use it. You can do this by running::
0 commit comments