Skip to content

Commit

Permalink
Doc: More Dev Deps (#1877)
Browse files Browse the repository at this point in the history
Conda:
- add full documentation for developer env

Spack:
- document a quick way to get all Python deps

Debian/Ubuntu (Apt):
- add missing FFTW MPI libs
- add more Python dependencies
  • Loading branch information
ax3l authored Apr 7, 2021
1 parent b0f4eff commit 8867092
Showing 1 changed file with 31 additions and 1 deletion.
32 changes: 31 additions & 1 deletion Docs/source/install/dependencies.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,20 @@ Spack (macOS/Linux)
spack add mpi
spack add pkgconfig # for fftw
# optional:
# spack add python
# spack add py-pip
# spack add cuda
spack install
(in new terminals, re-activate the environment with ``spack env activate warpx-dev`` again)

If you also want to run runtime tests and added Python above, install also these additional Python packages in the active Spack environment:

.. code-block:: bash
python -m pip install matplotlib==3.2.2 yt scipy numpy
Brew (macOS/Linux)
^^^^^^^^^^^^^^^^^^

Expand All @@ -65,11 +74,32 @@ Brew (macOS/Linux)
brew install pkg-config # for fftw
brew install open-mpi
Conda (Linux/macOS/Windows)
^^^^^^^^^^^^^^^^^^^^^^^^^^^

Without MPI:

.. code-block:: bash
conda create -n warpx-dev -c conda-forge ccache cmake compilers git openpmd-api python numpy scipy yt fftw matplotlib mamba ninja
conda activate warpx-dev
# compile WarpX with -DWarpX_MPI=OFF
With MPI (only Linux/macOS):

.. code-block:: bash
conda create -n warpx-dev -c conda-forge ccache cmake compilers git openpmd-api=*=mpi_openmpi* python numpy scipy yt fftw=*=mpi_openmpi* matplotlib mamba ninja openmpi
conda activate warpx-dev
Apt (Debian/Ubuntu)
^^^^^^^^^^^^^^^^^^^

.. code-block:: bash
sudo apt update
sudo apt install build-essential ccache cmake g++ libfftw3-dev libhdf5-openmpi-dev libopenmpi-dev pkg-config
sudo apt install build-essential ccache cmake g++ libfftw3-mpi-dev libfftw3-dev libhdf5-openmpi-dev libopenmpi-dev pkg-config python3 python3-matplotlib python3-numpy python3-scipy

0 comments on commit 8867092

Please sign in to comment.