From 9c1f8d839941d2b5eccc72c349fbc78832e66600 Mon Sep 17 00:00:00 2001 From: Robert Chisholm Date: Wed, 13 Sep 2023 12:24:01 +0100 Subject: [PATCH] Add MPI clarity to README. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8075f70e2..f237e8fd6 100644 --- a/README.md +++ b/README.md @@ -177,7 +177,7 @@ cmake --build . --target all | `FLAMEGPU_VERBOSE_PTXAS` | `ON`/`OFF` | Enable verbose PTXAS output during compilation. Default `OFF`. | | `FLAMEGPU_CURAND_ENGINE` | `XORWOW` / `PHILOX` / `MRG` | Select the CUDA random engine. Default `XORWOW` | | `FLAMEGPU_ENABLE_GLM` | `ON`/`OFF` | Experimental feature for GLM type support within models. Default `OFF`. | -| `FLAMEGPU_ENABLE_MPI` | `ON`/`OFF` | Enable MPI support for distributed CUDAEnsembles. Default `OFF`. | +| `FLAMEGPU_ENABLE_MPI` | `ON`/`OFF` | Enable MPI support for distributed CUDAEnsembles, each MPI worker should have exclusive access to it's GPUs e.g. 1 MPI worker per node. Default `OFF`. | | `FLAMEGPU_SHARE_USAGE_STATISTICS` | `ON`/`OFF` | Share usage statistics ([telemetry](https://docs.flamegpu.com/guide/telemetry)) to support evidencing usage/impact of the software. Default `ON`. | | `FLAMEGPU_TELEMETRY_SUPPRESS_NOTICE` | `ON`/`OFF` | Suppress notice encouraging telemetry to be enabled, which is emitted once per binary execution if telemetry is disabled. Defaults to `OFF`, or the value of a system environment variable of the same name. | | `FLAMEGPU_TELEMETRY_TEST_MODE` | `ON`/`OFF` | Submit telemetry values to the test mode of TelemetryDeck. Intended for use during development of FLAMEGPU rather than use. Defaults to `OFF`, or the value of a system environment variable of the same name.|