Merge pull request #3014 from steffengraber/add-random-note

Add note about missing random generators for osx-arm64
nest · Nov 28, 2023 · f622e24 · f622e24
2 parents 6290e7e + 0046656
commit f622e24
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 5 deletions.
diff --git a/doc/htmldoc/installation/conda_forge.rst b/doc/htmldoc/installation/conda_forge.rst
@@ -3,11 +3,17 @@
 Conda forge install
 ===================
 
-.. note:: 
-
-   If you encounter problems installing the NEST conda package and 
-   environment, we recommend using Mamba (https://mamba.readthedocs.io). 
-   Mamba has the advantage of installing conda packages and 
+.. admonition:: osx-arm64: missing random number generators
+
+   Due to a cross-compiling issue in the conda NEST package, some random number 
+   generators are not available if you are using macOS arm64 architecture. 
+   The available generators are the Mersenne Twister generators `mt19937` and `mt19937_64`.
+
+.. note::
+
+   If you encounter problems installing the NEST conda package and
+   environment, we recommend using Mamba (https://mamba.readthedocs.io).
+   Mamba has the advantage of installing conda packages and
    environments more quickly and can be used as a complete drop-in replacement for conda.
 
 1. To keep your conda setup tidy, we recommend that you install NEST into

diff --git a/doc/htmldoc/nest_behavior/random_numbers.rst b/doc/htmldoc/nest_behavior/random_numbers.rst
@@ -3,6 +3,12 @@
 Randomness in NEST Simulations
 ==============================
 
+.. admonition:: osx-arm64: missing random number generators
+
+   Due to a cross-compiling issue in the conda NEST package, some random number
+   generators are not available if you are using macOS arm64 architecture.
+   The available generators are the Mersenne Twister generators `mt19937` and `mt19937_64`.
+
 Random numbers in network simulations
 -------------------------------------