Skip to content

Commit

Permalink
Update installation instructions (#4790)
Browse files Browse the repository at this point in the history
Description of changes:
- add missing FFTW3 MPI library dependency
- pin Jupyter Notebook package versions (follow-up to #4789 (comment))
  • Loading branch information
kodiakhq[bot] authored Sep 19, 2023
2 parents 9517fa2 + ffac3db commit 9e4eea9
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions doc/sphinx/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ This chapter will describe how to get, compile and run the software.
|es| releases are available as source code packages from the homepage [1]_.
This is where new users should get the code. The code within release packages
is tested and known to run on a number of platforms.
Alternatively, people that want to use the newest features of |es| or that
want to start contributing to the software can instead obtain the
Alternatively, people who want to use the newest features of |es| or
start contributing to the software can instead obtain the
current development code via the version control system software [2]_
from |es|'s project page at Github [3]_. This code might be not as well
from |es|'s project page at GitHub [3]_. This code might be not as well
tested and documented as the release code; it is recommended to use this
code only if you have already gained some experience in using |es|.

Expand Down Expand Up @@ -93,7 +93,7 @@ To compile |es| on Ubuntu 22.04 LTS, install the following dependencies:
.. code-block:: bash
sudo apt install build-essential cmake cython3 python3-pip python3-numpy \
libboost-all-dev openmpi-common fftw3-dev libhdf5-dev libhdf5-openmpi-dev \
libboost-all-dev openmpi-common fftw3-dev libfftw3-mpi-dev libhdf5-dev libhdf5-openmpi-dev \
python3-scipy python3-opengl libgsl-dev freeglut3
Optionally the ccmake utility can be installed for easier configuration:
Expand Down Expand Up @@ -221,7 +221,7 @@ To use Jupyter Notebook, install the following packages:

.. code-block:: bash
pip3 install --user nbformat notebook 'jupyter_contrib_nbextensions==0.5.1'
pip3 install --user 'nbformat==5.1.3' 'nbconvert==6.4.5' 'notebook==6.4.8' 'jupyter_contrib_nbextensions==0.5.1'
jupyter contrib nbextension install --user
jupyter nbextension enable rubberband/main
jupyter nbextension enable exercise2/main
Expand Down

0 comments on commit 9e4eea9

Please sign in to comment.