File tree Expand file tree Collapse file tree 1 file changed +43
-0
lines changed Expand file tree Collapse file tree 1 file changed +43
-0
lines changed Original file line number Diff line number Diff line change @@ -13,3 +13,46 @@ The CI pipeline for this project is illustrated in the following diagram:
1313.. image :: ../_static/ci_graph.svg
1414 :alt: CI Pipeline Diagram
1515 :align: center
16+
17+ Running ``scripts/run_tests.py ``
18+ --------------------------------
19+
20+ Automated tests are executed through the ``scripts/run_tests.py `` helper. The
21+ script requires several environment variables to be defined:
22+
23+ ``PPC_NUM_THREADS ``
24+ Number of threads to use. The value is also exported as
25+ ``OMP_NUM_THREADS ``.
26+
27+ ``PPC_NUM_PROC ``
28+ Number of MPI processes to launch.
29+
30+ ``PPC_ASAN_RUN ``
31+ Set to ``1 `` when sanitizers are enabled to skip ``valgrind `` runs (optional,
32+ default ``0 ``).
33+
34+ ``PPC_IGNORE_TEST_TIME_LIMIT ``
35+ Set to ``1 `` to disable test time limits (optional, default ``0 ``).
36+
37+ The execution mode is selected with ``--running-type ``. The most common modes
38+ are ``threads `` for shared-memory backends and ``processes `` for MPI based
39+ tests. ``performance `` mode runs performance benchmarks.
40+
41+ Example usage:
42+
43+ .. code-block :: bash
44+
45+ export PPC_NUM_THREADS=4
46+ export PPC_NUM_PROC=2
47+
48+ # Multithreaded functional tests
49+ python3 scripts/run_tests.py --running-type=" threads"
50+
51+ # MPI functional tests
52+ python3 scripts/run_tests.py --running-type=" processes"
53+
54+ # Performance benchmarks
55+ python3 scripts/run_tests.py --running-type=" performance"
56+
57+ Additional MPI arguments can be supplied with ``--additional-mpi-args `` when
58+ running in ``processes `` mode.
You can’t perform that action at this time.
0 commit comments