Skip to content

Commit

Permalink
change installation guide for delight
Browse files Browse the repository at this point in the history
  • Loading branch information
hangqianjun committed Oct 22, 2024
1 parent 9b14421 commit c84a4bc
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -349,7 +349,7 @@ Installing Delight

.. tab:: General

For Delight you should be able to just do:
Delight is currently not pip installable. You will have to first install Delight follwing this [instruction](https://delight.readthedocs.io/en/latest/install.html) package, before installing the rail wrapper:

.. code-block:: bash
Expand All @@ -358,13 +358,15 @@ Installing Delight
.. tab:: Mac

For Delight you should be able to just do:
Delight is currently not pip installable. You will have to first install Delight follwing this [instruction](https://delight.readthedocs.io/en/latest/install.html) package, before installing the rail wrapper:

.. code-block:: bash
pip install pz-rail-delight
However, the particular estimator ``Delight`` is built with ``Cython`` and uses ``openmp``. Mac has dropped native support for ``openmp``, which will likely cause problems when trying to run the ``DelightEstimator`` estimation code in RAIL. See the notes below for instructions on installing Delight if you wish to use this particular estimator.
However, the particular estimator ``Delight`` is built with ``Cython`` and uses ``openmp``, both causes complications when installing on Mac.
If you are using the Mac M2 chip, you will first need to configure your C-compiler correctly.
Also, Mac has dropped native support for ``openmp``, which will likely cause problems when trying to run the ``DelightEstimator`` estimation code in RAIL. See the notes below for instructions on installing Delight if you wish to use this particular estimator.

If you are installing RAIL on a Mac, as noted above the ``DelightEstimator`` estimator requires that your machine's ``gcc`` be set up to work with ``openmp``. If you are installing on a Mac and do not plan on using ``DelightEstimator``, then you can simply install RAIL with ``pip install .[base]`` rather than ``pip install .[all]``, which will skip the Delight package. If you are on a Mac and *do* expect to run ``DelightEstimator``, then follow the instructions `here <https://github.com/LSSTDESC/Delight/blob/master/Mac_installation.md>`_ to install Delight before running ``pip install .[all]``.

Expand Down

0 comments on commit c84a4bc

Please sign in to comment.