Merge devin hs2

.azure-pipelines.yml

@@ -3,42 +3,50 @@
 pool:
   vmImage: 'ubuntu-20.04'
 
+trigger:
+  branches:
+    include:
+    - development
 pr:
   autoCancel: true
   drafts: false
+  paths:
+    exclude:
+    - Docs
+    - '**/*.rst'
 
 jobs:
 - job:
+  # FIXME remove unused variables
   variables:
     BLASPP_HOME: '/usr/local'
     CEI_SUDO: 'sudo'
     CEI_TMP: '/tmp/cei'
     CMAKE_GENERATOR: 'Ninja'
     FFTW_HOME: '/usr'
     LAPACKPP_HOME: '/usr/local'
-    OMP_NUM_THREADS: 1
     WARPX_CI_CCACHE: 'TRUE'
-    WARPX_CI_NUM_MAKE_JOBS: 2
-    WARPX_CI_OPENPMD: 'TRUE'
-    WARPX_CI_TMP: '/tmp/ci'
+    #WARPX_OPENPMD: 'TRUE'
 
   strategy:
     matrix:
-      cartesian1d:
-        WARPX_CI_REGULAR_CARTESIAN_1D: 'TRUE'
-        WARPX_CI_PSATD: 'FALSE'
-      cartesian2d:
-        WARPX_CI_REGULAR_CARTESIAN_2D: 'TRUE'
-      cartesian3d:
-        WARPX_CI_REGULAR_CARTESIAN_3D: 'TRUE'
-      single_precision:
-        WARPX_CI_SINGLE_PRECISION: 'TRUE'
-      rz_or_nompi:
-        WARPX_CI_RZ_OR_NOMPI: 'TRUE'
-      qed:
-        WARPX_CI_QED: 'TRUE'
-      embedded_boundary:
-        WARPX_CI_EB: 'TRUE'
+      # Cartesian 1D
+      cartesian_1d:
+        WARPX_CMAKE_FLAGS: -DWarpX_DIMS=1 -DWarpX_FFT=ON -DWarpX_PYTHON=ON
+      # Cartesian 2D
+      cartesian_2d:
+        WARPX_CMAKE_FLAGS: -DWarpX_DIMS=2 -DWarpX_FFT=ON -DWarpX_PYTHON=ON
+      # Cartesian 3D
+      cartesian_3d:
+        WARPX_CMAKE_FLAGS: -DWarpX_DIMS=3 -DWarpX_FFT=ON -DWarpX_PYTHON=ON
+      # Cylindrical RZ
+      cylindrical_rz:
+        WARPX_CMAKE_FLAGS: -DWarpX_DIMS=RZ -DWarpX_FFT=ON -DWarpX_PYTHON=ON
+        WARPX_RZ_FFT: 'TRUE'
+      # single precision
+      #single_precision:
+      #  WARPX_CMAKE_FLAGS: -DWarpX_DIMS='1;2;3;RZ' -DWarpX_FFT=ON -DWarpX_PYTHON=ON -DWarpX_PRECISION=SINGLE
+      #  WARPX_RZ_FFT: 'TRUE'
 
   # default: 60; maximum: 360
   timeoutInMinutes: 240
@@ -50,28 +58,16 @@ jobs:
   - task: Cache@2
     continueOnError: true
     inputs:
-      key: 'Ccache | "$(System.JobName)" | .azure-pipelines.yml | cmake/dependencies/AMReX.cmake | run_test.sh'
+      key: 'Ccache | "$(System.JobName)" | .azure-pipelines.yml | cmake/dependencies/AMReX.cmake'
       restoreKeys: |
-         Ccache | "$(System.JobName)" | .azure-pipelines.yml | cmake/dependencies/AMReX.cmake | run_test.sh
          Ccache | "$(System.JobName)" | .azure-pipelines.yml | cmake/dependencies/AMReX.cmake
          Ccache | "$(System.JobName)" | .azure-pipelines.yml
       path: /home/vsts/.ccache
       cacheHitVar: CCACHE_CACHE_RESTORED
     displayName: Cache Ccache Objects
 
-  - task: Cache@2
-    continueOnError: true
-    inputs:
-      key: 'Python3 | "$(System.JobName)" | .azure-pipelines.yml | run_test.sh'
-      restoreKeys: |
-         Python3 | "$(System.JobName)" | .azure-pipelines.yml | run_test.sh
-         Python3 | "$(System.JobName)" | .azure-pipelines.yml
-      path: /home/vsts/.local/lib/python3.8
-      cacheHitVar: PYTHON38_CACHE_RESTORED
-    displayName: Cache Python Libraries
-
   - bash: |
-      set -eu -o pipefail
+      set -o nounset errexit pipefail
       cat /proc/cpuinfo | grep "model name" | sort -u
       df -h
       echo 'Acquire::Retries "3";' | sudo tee /etc/apt/apt.conf.d/80-retries
@@ -82,6 +78,8 @@ jobs:
         python3 python3-pandas python3-pip python3-venv python3-setuptools libblas-dev liblapack-dev
       ccache --set-config=max_size=10.0G
       python3 -m pip install --upgrade pip
+      python3 -m pip install --upgrade build
+      python3 -m pip install --upgrade packaging
       python3 -m pip install --upgrade setuptools
       python3 -m pip install --upgrade wheel
       python3 -m pip install --upgrade virtualenv
@@ -91,32 +89,86 @@ jobs:
       export PATH="$HOME/.local/bin:$PATH"
       sudo curl -L -o /usr/local/bin/cmake-easyinstall https://raw.githubusercontent.com/ax3l/cmake-easyinstall/main/cmake-easyinstall
       sudo chmod a+x /usr/local/bin/cmake-easyinstall
-      if [ "${WARPX_CI_OPENPMD:-FALSE}" == "TRUE" ]; then
-        cmake-easyinstall --prefix=/usr/local                   \
-          git+https://github.com/openPMD/openPMD-api.git@0.14.3 \
-          -DCMAKE_CXX_COMPILER_LAUNCHER=$(which ccache)         \
-          -DCMAKE_VERBOSE_MAKEFILE=ON                           \
-          -DopenPMD_USE_PYTHON=OFF -DBUILD_TESTING=OFF -DBUILD_EXAMPLES=OFF -DBUILD_CLI_TOOLS=OFF
-        python3 -m pip install --upgrade openpmd-api
-      fi
-      if [[ "${WARPX_CI_RZ_OR_NOMPI:-FALSE}" == "TRUE" ]]; then
-        cmake-easyinstall --prefix=/usr/local git+https://github.com/icl-utk-edu/blaspp.git \
+      #if [ "${WARPX_OPENPMD:-FALSE}" == "TRUE" ]; then
+      #  cmake-easyinstall --prefix=/usr/local                   \
+      #    git+https://github.com/openPMD/openPMD-api.git@0.14.3 \
+      #    -DCMAKE_CXX_COMPILER_LAUNCHER=$(which ccache)         \
+      #    -DCMAKE_VERBOSE_MAKEFILE=ON                           \
+      #    -DopenPMD_USE_PYTHON=OFF -DBUILD_TESTING=OFF -DBUILD_EXAMPLES=OFF -DBUILD_CLI_TOOLS=OFF
+      #  #python3 -m pip install --upgrade openpmd-api
+      #fi
+      if [ "${WARPX_RZ_FFT:-FALSE}" == "TRUE" ]; then
+        # BLAS++
+        cmake-easyinstall --prefix=/usr/local           \
+          git+https://github.com/icl-utk-edu/blaspp.git \
           -DCMAKE_CXX_COMPILER_LAUNCHER=$(which ccache) \
           -DCMAKE_CXX_STANDARD=17                       \
           -Duse_openmp=OFF -Dbuild_tests=OFF -DCMAKE_VERBOSE_MAKEFILE=ON
-        cmake-easyinstall --prefix=/usr/local git+https://github.com/icl-utk-edu/lapackpp.git \
-          -DCMAKE_CXX_COMPILER_LAUNCHER=$(which ccache) \
-          -DCMAKE_CXX_STANDARD=17                       \
+        # LAPACK++
+        cmake-easyinstall --prefix=/usr/local             \
+          git+https://github.com/icl-utk-edu/lapackpp.git \
+          -DCMAKE_CXX_COMPILER_LAUNCHER=$(which ccache)   \
+          -DCMAKE_CXX_STANDARD=17                         \
           -Duse_cmake_find_lapack=ON -Dbuild_tests=OFF -DCMAKE_VERBOSE_MAKEFILE=ON
       fi
+      # Python modules required for test analysis
+      python3 -m pip install --upgrade -r Regression/requirements.txt
+      python3 -m pip cache purge
+      # external repositories required for test analysis
+      cd ..
+      git clone --depth 1 https://github.com/ECP-WarpX/warpx-data.git
+      # TODO select only specific datasets?
+      git clone --depth 1 https://github.com/openPMD/openPMD-example-datasets.git
+      cd -
       rm -rf ${CEI_TMP}
       df -h
     displayName: 'Install dependencies'
 
   - bash: |
-      set -eu -o pipefail
+      # set options
+      set -o nounset errexit pipefail
+      # display disk space usage
       df -h
-      ./run_test.sh
-      rm -rf ${WARPX_CI_TMP}
+      # configure
+      export AMReX_CMAKE_FLAGS="-DAMReX_ASSERTIONS=ON -DAMReX_TESTING=ON"
+      export WARPX_TEST_FLAGS="-DWarpX_TEST_CLEANUP=ON -DWarpX_TEST_FPETRAP=ON -DWarpX_BACKTRACE_INFO=ON"
+      cmake -S . -B build    \
+        ${AMReX_CMAKE_FLAGS} \
+        ${WARPX_CMAKE_FLAGS} \
+        ${WARPX_TEST_FLAGS}
+      # build
+      cmake --build build -j 2
+      # display disk space usage
       df -h
-    displayName: 'Build & test'
+    displayName: 'Build'
+
+  - bash: |
+      # set options
+      set -o nounset errexit pipefail
+      # determine if the build was triggered by a push to the development branch
+      if [[ "$(Build.SourceBranch)" == "refs/heads/development" ]]; then
+        # run tests (exclude pytest.AMReX when running Python tests)
+        # and submit results to CDash as Experimental
+        ctest --test-dir build --output-on-failure -E AMReX \
+          -D ExperimentalTest -D ExperimentalSubmit
+      else
+        # run tests (exclude pytest.AMReX when running Python tests)
+        ctest --test-dir build --output-on-failure -E AMReX
+      fi
+    displayName: 'Test'
+
+  - bash: |
+      # set options
+      set -o nounset errexit pipefail
+      # find and print backtrace
+      find build/bin/ -type f -name "Backtrace*" \
+        -exec echo -e "\nBacktrace\n---------\n{}\n---------" \; \
+        -exec cat {} \;
+    displayName: 'Logs'
+    condition: always()
+
+  - bash: |
+      # clean out so the Post-job Cache "tar" command has more disk space available
+      rm -rf build
+    displayName: 'Clean Build Directory'
+    condition: always()

.clang-tidy

@@ -19,6 +19,7 @@ Checks: '
         -cppcoreguidelines-avoid-non-const-global-variables,
         -cppcoreguidelines-init-variables,
         -cppcoreguidelines-macro-usage,
+        -cppcoreguidelines-missing-std-forward,
         -cppcoreguidelines-narrowing-conversions,
         -cppcoreguidelines-non-private-member-variables-in-classes,
         -cppcoreguidelines-owning-memory,
@@ -29,6 +30,7 @@ Checks: '
     misc-*,
         -misc-no-recursion,
         -misc-non-private-member-variables-in-classes,
+        -misc-include-cleaner,
     modernize-*,
         -modernize-avoid-c-arrays,
         -modernize-return-braced-init-list,
@@ -55,6 +57,9 @@ CheckOptions:
   value:        "H,"
 - key:          modernize-pass-by-value.ValuesOnly
   value:        "true"
-
+- key:          misc-use-anonymous-namespace.HeaderFileExtensions
+  value:        "H,"
+- key:          performance-move-const-arg.CheckTriviallyCopyableMove
+  value:        "false"
 
 HeaderFilterRegex: 'Source[a-z_A-Z0-9\/]+\.H$'

.github/ISSUE_TEMPLATE/blank_issue.md

@@ -0,0 +1,14 @@
+---
+name: Blank issue
+about: Ask us a question
+labels: [question]
+---
+
+Are you here because you have something to report that is neither a bug, a new feature, nor an installation problem?
+
+Before opening this issue, consider opening a [discussion](https://github.com/ECP-WarpX/WarpX/discussions) instead!
+
+Issues are used to report bugs, installation problems or to request new features.
+Discussions are used to ask more open-ended questions, brainstorm, ask our feedback, etc.
+
+You can find more details on how to use issues and discussions [here](https://github.com/ECP-WarpX/WarpX/blob/development/CONTRIBUTING.rst).

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,58 @@
+---
+name: Bug report
+about: Report a bug or unexpected behavior.
+labels: [bug]
+---
+
+_Please remove any sensitive information (e.g., passwords, API keys) from your submission.
+Please check the relevant boxes and fill in the specific versions or details for the relevant items.
+Thank you for taking the time to report this issue. We will respond as soon as possible._
+
+## Description
+A clear and concise description of the bug.
+
+## Expected behavior
+What did you expect to happen when you encountered the issue?
+
+## How to reproduce
+Please provide (if available):
+- WarpX inputs files
+- PICMI Python files
+- Python post-processing scripts
+
+If you are unable to provide certain files or scripts, please describe the steps you took to encounter the issue.
+
+Please minimize your inputs/scripts to be concise and focused on the issue.
+For instance, make the simulation scripts as small and fast to run as possible.
+
+## System information
+Please check all relevant boxes and provide details.
+
+- Operating system (name and version):
+  - [ ] Linux: e.g., Ubuntu 22.04 LTS
+  - [ ] macOS: e.g., macOS Monterey 12.4
+  - [ ] Windows: e.g., Windows 11 Pro
+- Version of WarpX: e.g., latest, 24.10, etc.
+- Installation method:
+  - [ ] Conda
+  - [ ] Spack
+  - [ ] PyPI
+  - [ ] Brew
+  - [ ] From source with CMake
+  - [ ] Module system on an HPC cluster
+- Other dependencies: yes/no, describe
+- Computational resources:
+  - [ ] MPI: e.g., 2 MPI processes
+  - [ ] OpenMP: e.g., 2 OpenMP threads
+  - [ ] CPU: e.g., 2 CPUs
+  - [ ] GPU: e.g., 2 GPUs (NVIDIA, AMD, etc.)
+
+If you encountered the issue on an HPC cluster, please check our [HPC documentation](https://warpx.readthedocs.io/en/latest/install/hpc.html) to see if your HPC cluster is already supported.
+
+## Steps taken so far
+What troubleshooting steps have you taken so far, and what were the results?
+
+Have you tried debugging the code, following the instructions in our [debugging documentation](https://warpx.readthedocs.io/en/latest/usage/workflows/debugging.html)?
+
+## Additional information
+If applicable, please add any additional information that may help explain the issue, such as log files (e.g., build logs, error logs, etc.), error messages (e.g., compiler errors, runtime errors, etc.), screenshots, or other relevant details.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,27 @@
+---
+name: Feature request
+about: Suggest a new feature or enhancement.
+labels: [enhancement]
+---
+
+_Please remove any sensitive information (e.g., passwords, API keys) from your submission.
+Please check the relevant boxes and fill in the specific versions or details for the relevant items.
+Thank you for taking the time to report this issue. We will respond as soon as possible._
+
+## Context and motivation
+Please provide a clear and concise description of the context that is prompting you to request a new feature. What problem are you trying to solve, and how will this feature help you achieve your goals?
+
+## Proposed feature
+Describe the feature you would like to add to WarpX in detail. Please include:
+- A clear and concise description of the feature
+- Any relevant technical requirements or specifications
+- How you envision the feature being used
+
+## Alternative solutions
+Have you considered any alternative solutions or features that could achieve the same goal? If so, please describe them and explain why you believe the proposed feature is the best solution.
+
+## Additional information
+If applicable, please provide any additional information that may be relevant to the feature request, such as:
+- Links to existing codes or implementations
+- References to relevant publications or research
+- Any specific use cases or scenarios where the feature would be particularly useful

.github/ISSUE_TEMPLATE/installation-issue.md

@@ -0,0 +1,49 @@
+---
+name: Installation issue
+about: Report an issue with installing or setting up WarpX.
+labels: [install]
+---
+
+_Please remove any sensitive information (e.g., passwords, API keys) from your submission.
+Please check the relevant boxes and fill in the specific versions or details for the relevant items.
+Thank you for taking the time to report this issue. We will respond as soon as possible._
+
+## Description
+A clear and concise description of the issue.
+
+## System information
+- Operating system (name and version):
+  - [ ] Linux: e.g., Ubuntu 22.04 LTS
+  - [ ] macOS: e.g., macOS Monterey 12.4
+  - [ ] Windows: e.g., Windows 11 Pro
+- Version of WarpX: e.g., latest, 24.10, etc.
+- Installation method:
+  - [ ] Conda
+  - [ ] Spack
+  - [ ] PyPI
+  - [ ] Brew
+  - [ ] From source with CMake
+  - [ ] Module system on an HPC cluster
+- Other dependencies: yes/no, describe
+- Computational resources:
+  - [ ] CPU
+  - [ ] GPU: e.g., NVIDIA, AMD, etc.
+
+If you encountered the issue on an HPC cluster, please check our [HPC documentation](https://warpx.readthedocs.io/en/latest/install/hpc.html) to see if your HPC cluster is already supported.
+
+If you encountered the issue installing from source with CMake, please provide the output of the following steps:
+1. buildsystem generation: output of `cmake --fresh -S . -B build` (include your specific build options, e.g., `-DWarpX_DIMS=3`)
+2. project build: output of `cmake --build build` (include your specific build options, e.g., `-j 4`)
+
+If applicable, please add any additional information about your software environment:
+- [ ] CMake: e.g., 3.24.0
+- [ ] C++ compiler: e.g., GNU 11.3 with NVCC 12.0.76
+- [ ] Python: e.g., CPython 3.12
+- [ ] MPI: e.g., OpenMPI 4.1.1
+- [ ] FFTW: e.g., 3.3.10
+- [ ] HDF5: e.g., 1.14.0
+- [ ] ADIOS2: e.g., 2.10.0
+- Other dependencies: yes/no, describe
+
+## Additional information
+If applicable, please add any additional information that may help explain the issue, such as log files (e.g., build logs, error logs, etc.), error messages (e.g., compiler errors, runtime errors, etc.), screenshots, or other relevant details.