Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ESS2019 installation guide updates #3236

Merged
merged 6 commits into from
Oct 11, 2019
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -336,7 +336,7 @@ endif(WITH_VALGRIND_INSTRUMENTATION)
# MPI
#

find_package(MPI REQUIRED)
find_package(MPI 3.0 REQUIRED)

# CMake < 3.9
if(NOT TARGET MPI::MPI_CXX)
Expand Down
90 changes: 67 additions & 23 deletions doc/sphinx/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -114,52 +114,96 @@ ROCm SDK to make use of GPU computation:
sudo apt update
sudo apt install libnuma-dev rocm-dkms rocblas rocfft rocrand rocthrust

After installing the ROCm SDK, please reboot your computer.

.. _Installing Requirements on Mac OS X:

Installing Requirements on Mac OS X
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To make |es| run on Mac OS X 10.9 or higher, its dependencies can be
installed using MacPorts. First, download the installer package
appropriate for your Mac OS X version from
https://www.macports.org/install.php and install it. Then, run the
Preparation
"""""""""""

To make |es| run on Mac OS X 10.9 or higher, you need to install its
dependencies. There are two possibilities for this, MacPorts and Homebrew.
We recommend MacPorts, but if you already have Homebrew installed, you can use
that too. To check whether you already have one or the other installed, run the
following commands:

.. code-block:: bash

test -e /opt/local/bin/port && echo "MacPorts is installed"
test -e /usr/local/bin/brew && echo "Homebrew is installed"

If both are installed, you need to remove one of the two. To do that, run one
of the following two commands:

.. code-block:: bash

sudo port -f uninstall installed && rm -r /opt/local
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/uninstall)"

If Homebrew is already installed, you should resolve any problems reported by
the command

.. code-block:: bash

brew doctor

If Anaconda Python or the Python from www.python.org are installed, you
will likely not be able to run |es|. Therefore, please uninstall them
using the following commands:

.. code-block:: bash

sudo rm -r ~/anaconda[23]
sudo rm -r /Library/Python

If you want to install MacPorts, download the installer package
appropriate for your Mac OS X version from
https://www.macports.org/install.php and install it.

If you want to install Homebrew, use the following commands.

.. code-block:: bash

sudo xcode-select --install
sudo xcodebuild -license accept
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

Installing Packages using MacPorts
""""""""""""""""""""""""""""""""""

Run thefollowing commands:

.. code-block:: bash

sudo xcode-select --install
sudo xcodebuild -license accept
sudo port selfupdate
sudo port install cmake python37 py37-cython py37-numpy \
openmpi-default fftw-3 +openmpi boost +openmpi +python37 \
doxygen py37-opengl py37-sphinx py37-pip gsl hdf5 +openmpi
doxygen py37-opengl py37-sphinx py37-pip gsl hdf5 +openmpi \
mkuron marked this conversation as resolved.
Show resolved Hide resolved
py37-matplotlib py37-ipython py37-jupyter
sudo port select --set cython cython37
sudo port select --set python3 python37
sudo port select --set pip pip37
sudo port select --set mpi openmpi-mp

Alternatively, you can use Homebrew.

.. code-block:: bash

sudo xcode-select --install
sudo xcodebuild -license accept
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
brew install cmake python@3 cython boost boost-mpi fftw \
doxygen gsl
brew install hdf5 --with-mpi
brew install numpy --without-python@2
ln -s /usr/local/bin/python2 /usr/local/bin/python
pip install --user PyOpenGL

Note: If both MacPorts and Homebrew are installed, you will not be able to
run |es|. Therefore, if you have both installed, please uninstall one
or the other by running one of the following two commands:
Installing Packages using Homebrew
""""""""""""""""""""""""""""""""""

.. code-block:: bash

sudo port -f uninstall installed && rm -r /opt/local
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/uninstall)"
brew install cmake python cython boost boost-mpi fftw \
doxygen gsl numpy ipython jupyter
brew install hdf5
brew link --force cython
pip install PyOpenGL matplotlib

Installing CUDA
"""""""""""""""

If your Mac has an Nvidia graphics card, you should also download and install the
CUDA SDK [6]_ to make use of GPU computation.
Expand Down