Skip to content

Commit

Permalink
Docs: Update Regression Testing (CMake)
Browse files Browse the repository at this point in the history
  • Loading branch information
ax3l committed Dec 29, 2021
1 parent 31dc27f commit 8cfe42d
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -395,7 +395,7 @@ endif()
#

# calling `python -m pip wheel .` and install re-using the build directory
# note: this is mainly for our CI Python regression scrips, users and package
# note: this is mainly for our CI Python regression scripts, users and package
# managers should just use `python -m pip wheel .` and `... install *whl`
# directly
set(PYINSTALLOPTIONS "" CACHE STRING "Additional parameters to pass to `pip install`")
Expand Down
11 changes: 9 additions & 2 deletions Docs/source/developers/testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -89,11 +89,12 @@ There are three steps to follow to add a new automated test (illustrated here fo
runtime_params = warpx.do_dynamic_scheduling=0 algo.maxwell_solver=yee
dim = 2
addToCompileString =
cmakeSetupOpts = -DWarpX_DIMS=2
restartTest = 0
useMPI = 1
numprocs = 2
useOMP = 1
numthreads = 2
numthreads = 1
compileTest = 0
doVis = 0
analysisRoutine = Examples/Tests/PML/analysis_pml_yee.py
Expand All @@ -104,8 +105,14 @@ If you re-use an existing input file, you can add arguments to ``runtime_params`

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.

.. note::

We run those tests on our continuous integration services, which at the moment only have 2 virtual CPU cores.
Thus, make sure that the product of ``numprocs`` and ``numthreads`` for a test is ``<=2``.


Useful tool for plotfile comparison: ``fcompare``
--------------------------------------------------
-------------------------------------------------

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:

Expand Down

0 comments on commit 8cfe42d

Please sign in to comment.