Add warnings about viewer issue

mctools · Mar 15, 2024 · 982559b · 982559b
1 parent a133999
commit 982559b
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/doc/source/install.rst b/doc/source/install.rst
@@ -124,6 +124,13 @@ diffraction is enabled), so all (singly) scattered neutrons (green) should end
 up in a single Debye-Scherrer cone. Other particles like gammas (yellow) are
 generated in absorption events, based on Geant4's own built-in physics.
 
+.. warning::
+    There is a known issue on macOS where the viewer will either crash
+    or only use part of the graphics window. There is a workaround described `in
+    this comment
+    <https://github.com/mctools/simplebuild-dgcode/issues/38#issuecomment-1999469177>`__.
+
+
 It might also be a good idea to verify that the Matplotlib-based
 :ref:`SimpleHists <sbsimplehists>` plotting works, which can be done with the
 command::

diff --git a/doc/source/vis.rst b/doc/source/vis.rst
@@ -35,6 +35,12 @@ And the viewer is launched:
 
 |image1|
 
+.. warning::
+    There is a known issue on macOS where the viewer will either crash
+    or only use part of the graphics window. There is a workaround described `in
+    this comment
+    <https://github.com/mctools/simplebuild-dgcode/issues/38#issuecomment-1999469177>`__.
+
 Grab the mouse and change the view as you see fit:
 
 * **Left-click + move**: rotate view.