diff options
Diffstat (limited to 'Docs/source')
-rw-r--r-- | Docs/source/building/cmake.rst | 6 | ||||
-rw-r--r-- | Docs/source/building/lassen.rst | 2 | ||||
-rw-r--r-- | Docs/source/building/quartz.rst | 2 | ||||
-rw-r--r-- | Docs/source/building/summit.rst | 2 |
4 files changed, 7 insertions, 5 deletions
diff --git a/Docs/source/building/cmake.rst b/Docs/source/building/cmake.rst index bf6821c70..9aac1d948 100644 --- a/Docs/source/building/cmake.rst +++ b/Docs/source/building/cmake.rst @@ -26,6 +26,7 @@ Please see installation instructions below. - a mature `C++14 <https://en.wikipedia.org/wiki/C%2B%2B14>`_ compiler: e.g. GCC 5, Clang 3.6 or newer - `CMake 3.15.0+ <https://cmake.org>`_ - `AMReX <https://amrex-codes.github.io>`_: we automatically download and compile a copy of AMReX +- `PICSAR <https://github.com/ECP-WarpX/picsar>`_: we automatically download and compile a copy of PICSAR Optional dependencies include: @@ -33,7 +34,7 @@ Optional dependencies include: - `CUDA Toolkit 9.0+ <https://developer.nvidia.com/cuda-downloads>`_: for Nvidia GPU support (see `matching host-compilers <https://gist.github.com/ax3l/9489132>`_) - `OpenMP 3.1+ <https://www.openmp.org>`_: for threaded CPU execution (currently not fully accelerated) - `FFTW3 <http://www.fftw.org>`_: for spectral solver (PSATD) support -- `Boost 1.66.0+ <https://www.boost.org/>`_: for QED support +- `Boost 1.66.0+ <https://www.boost.org/>`_: for QED lookup tables generation support - `openPMD-api 0.12.0+ <https://github.com/openPMD/openPMD-api>`_: we automatically download and compile a copy of openPMD-api for openPMD I/O support - see `optional I/O backends <https://github.com/openPMD/openPMD-api#dependencies>`_ @@ -136,7 +137,8 @@ CMake Option Default & Values Descr ``WarpX_PARSER_DEPTH`` **24** Maximum parser depth for input file functions ``WarpX_PRECISION`` SINGLE/**DOUBLE** Floating point precision (single/double) ``WarpX_PSATD`` ON/**OFF** Spectral solver -``WarpX_QED`` ON/**OFF** PICSAR QED (requires Boost and PICSAR) +``WarpX_QED`` **ON**/OFF QED support (requires PICSAR) +``WarpX_QED_TABLE_GEN`` ON/**OFF** QED table generation support (requires PICSAR and Boost) ``WarpX_amrex_repo`` ``https://github.com/AMReX-Codes/amrex.git`` Repository URI to pull and build AMReX from ``WarpX_amrex_branch`` ``development`` Repository branch for ``WarpX_amrex_repo`` ``WarpX_amrex_internal`` **ON**/OFF Needs a pre-installed AMReX library if set to ``OFF`` diff --git a/Docs/source/building/lassen.rst b/Docs/source/building/lassen.rst index f5a5bcccc..9387d2c9f 100644 --- a/Docs/source/building/lassen.rst +++ b/Docs/source/building/lassen.rst @@ -40,7 +40,7 @@ We use the following modules and environments on the system. # optional: for PSATD support module load fftw/3.3.8 - # optional: for QED support + # optional: for QED lookup table generation support module load boost/1.70.0 # optional: for openPMD support diff --git a/Docs/source/building/quartz.rst b/Docs/source/building/quartz.rst index 139f047d3..baedf345b 100644 --- a/Docs/source/building/quartz.rst +++ b/Docs/source/building/quartz.rst @@ -40,7 +40,7 @@ We use the following modules and environments on the system. # optional: for PSATD support module load fftw/3.3.8 - # optional: for QED support + # optional: for QED lookup table generation support module load boost/1.73.0 # optional: for openPMD support diff --git a/Docs/source/building/summit.rst b/Docs/source/building/summit.rst index e1d8fd3c4..76aaeca11 100644 --- a/Docs/source/building/summit.rst +++ b/Docs/source/building/summit.rst @@ -50,7 +50,7 @@ We use the following modules and environments on the system. # optional: for PSATD support module load fftw - # optional: for QED support + # optional: for QED lookup table generation support module load boost/1.66.0 # optional: for openPMD support |