Skip to content

Commit 23aefbc

Browse files
committed
Docs: Update Regression Testing (CMake)
1 parent 7999bf6 commit 23aefbc

File tree

2 files changed

+10
-3
lines changed

2 files changed

+10
-3
lines changed

CMakeLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -395,7 +395,7 @@ endif()
395395
#
396396

397397
# calling `python -m pip wheel .` and install re-using the build directory
398-
# note: this is mainly for our CI Python regression scrips, users and package
398+
# note: this is mainly for our CI Python regression scripts, users and package
399399
# managers should just use `python -m pip wheel .` and `... install *whl`
400400
# directly
401401
set(PYINSTALLOPTIONS "" CACHE STRING "Additional parameters to pass to `pip install`")

Docs/source/developers/testing.rst

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,11 +89,12 @@ There are three steps to follow to add a new automated test (illustrated here fo
8989
runtime_params = warpx.do_dynamic_scheduling=0 algo.maxwell_solver=yee
9090
dim = 2
9191
addToCompileString =
92+
cmakeSetupOpts = -DWarpX_DIMS=2
9293
restartTest = 0
9394
useMPI = 1
9495
numprocs = 2
9596
useOMP = 1
96-
numthreads = 2
97+
numthreads = 1
9798
compileTest = 0
9899
doVis = 0
99100
analysisRoutine = Examples/Tests/PML/analysis_pml_yee.py
@@ -104,8 +105,14 @@ If you re-use an existing input file, you can add arguments to ``runtime_params`
104105

105106
If you added ``analysisRoutine = Examples/analysis_default_regression.py``, then run the new test case locally and add the :ref:`checksum <developers-checksum>` file for the expected output.
106107

108+
.. note::
109+
110+
We run those tests on our continuous integration services, which at the moment only have 2 virtual CPU cores.
111+
Thus, make sure that the product of ``numprocs`` and ``numthreads`` for a test is ``<=2``.
112+
113+
107114
Useful tool for plotfile comparison: ``fcompare``
108-
--------------------------------------------------
115+
-------------------------------------------------
109116

110117
AMReX provides ``fcompare``, an executable that takes two ``plotfiles`` as input and returns the absolute and relative difference for each field between these two plotfiles. For some changes in the code, it is very convenient to run the same input file with an old and your current version, and ``fcompare`` the plotfiles at the same iteration. To use it:
111118

0 commit comments

Comments
 (0)