Skip to content

Commit 06937ac

Browse files
author
Dimitar Tasev
authored
Merge pull request #771 from mantidproject/755_troubleshooting_page
2 parents 008ca57 + 9c1d31b commit 06937ac

File tree

6 files changed

+127
-8
lines changed

6 files changed

+127
-8
lines changed

‎docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@
5151

5252
# General information about the project.
5353
project = u'MantidImaging'
54-
copyright = u'2017, Mantid Project'
54+
copyright = u'2017-2020, Mantid Project'
5555
author = u'Dimitar Tasev, Dan Nixon'
5656

5757
# The version info for the project you're documenting, acts as replacement for

‎docs/developer_guide/index.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ Note: this hasn't been kept up
88
:maxdepth: 1
99
:caption: Contents:
1010

11-
start_here
1211
documentation
13-
tests
1412
conda_packaging_and_docker_image
1513
release

‎docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ such as `Avizo
1717
installation
1818
user_guide/index
1919
developer_guide/index
20+
troubleshooting
2021
api
2122

2223
.. toctree::

‎docs/installation.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ have one on your machine.
1515
1. These dependencies must be present on your system before installing the Mantid Imaging environment.
1616
Please look for instructions specific to your OS on how to do that:
1717

18-
1918
- Qt5 - https://doc.qt.io/qt-5/gettingstarted.html
2019
- CUDA Runtime version 10.2 - https://developer.nvidia.com/cuda-10.2-download-archive
2120

‎docs/troubleshooting.rst

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
.. _Troubleshooting:
2+
3+
Troubleshooting
4+
===============
5+
6+
Updating Mantid Imaging on IDAaaS
7+
---------------------------------
8+
9+
Updating Unstable package
10+
#########################
11+
12+
To update the unstable package please copy and run this command in a terminal:
13+
14+
.. code-block:: bash
15+
16+
source /opt/miniconda/bin/activate /opt/miniconda && ENVIRONMENT_NAME=mantidimaging_unstable REPO_LABEL=unstable source <(curl -s https://raw.githubusercontent.com/mantidproject/mantidimaging/master/install.sh)
17+
18+
Updating Release package
19+
########################
20+
21+
To update the release package please copy and run this command in a terminal:
22+
23+
.. code-block:: bash
24+
25+
source /opt/miniconda/bin/activate /opt/miniconda && source <(curl -s https://raw.githubusercontent.com/mantidproject/mantidimaging/master/install.sh)
26+
27+
Updating when not on IDAaaS
28+
###########################
29+
30+
When updating the package, and not on IDAaaS, you will have to:
31+
32+
- Open a terminal which has the :code:`base` Anaconda environment activated, or
33+
- replace the :code:`/opt/miniconda/` paths in :code:`source /opt/miniconda/bin/activate /opt/miniconda`
34+
command with the path where :code:`conda` is installed on your system.
35+
36+
Afterwards run the remainder of the command to update the environment:
37+
38+
- For Unstable
39+
40+
.. code-block:: bash
41+
42+
ENVIRONMENT_NAME=mantidimaging_unstable REPO_LABEL=unstable source <(curl -s https://raw.githubusercontent.com/mantidproject/mantidimaging/master/install.sh)
43+
44+
45+
- For Release
46+
47+
.. code-block:: bash
48+
49+
source <(curl -s https://raw.githubusercontent.com/mantidproject/mantidimaging/master/install.sh)
50+
51+
52+
53+
Can't reconstruct with FBP_CUDA and SIRT_CUDA
54+
---------------------------------------------
55+
56+
These algorithms have 2 requirements:
57+
58+
- Having a CUDA-compatible graphics card (GPU)
59+
- Having the CUDA Runtime 10.2 libraries installed
60+
61+
62+
Having a CUDA-compatible graphics card
63+
######################################
64+
65+
Please check that your GPU is on the list of compatible GPUs https://developer.nvidia.com/cuda-gpus
66+
67+
Having the CUDA Runtime 10.2 libraries installed
68+
################################################
69+
70+
Please install the CUDA Runtime version 10.2 binaries from https://developer.nvidia.com/cuda-10.2-download-archive
71+
72+
Reinstalling CUDA on Linux can be quickly done with this script
73+
74+
75+
.. code-block:: bash
76+
77+
# uninstall nvidia driver and cuda driver
78+
nvidia-uninstall && /usr/local/cuda/bin/cuda-uninstaller
79+
80+
# download the CUDA installer
81+
wget http://developer.download.nvidia.com/compute/cuda/10.2/Prod/local_installers/cuda_10.2.89_440.33.01_linux.run ~/Downloads/cuda_10.2.89_440.33.01_linux.run
82+
83+
# install GPU driver and CUDA Toolkit from CLI silently
84+
sudo bash ~/Downloads/cuda_10.2.89_440.33.01_linux.run --silent --driver --toolkit
85+
86+
87+
Specific Errors
88+
===============
89+
90+
91+
SystemError: <built-in function connectSlotsByName> returned a result with an error set
92+
---------------------------------------------------------------------------------------
93+
94+
This means that the PyQt package is missing or an old version (it must be newer than PyQt5==5.13.2)
95+
96+
Suggested Fix
97+
#############
98+
99+
Install PyQt5 and pyqtgraph with :code:`pip install pyqt5==5.15 pyqtgraph==0.11`
100+
101+
102+
103+
qt.qpa.plugin: Could not load the Qt platform plugin "xcb" in "" even though it was found.
104+
----------------------------------------------------------------------------------------------
105+
106+
This might mean some system libraries are missing
107+
108+
Suggested Fix
109+
#############
110+
111+
Try installing :code:`apt install libxcb-xinerama0`
112+
113+
qt.qpa.xcb: could not connect to display...
114+
-------------------------------------------
115+
116+
Missing :code:`DISPLAY` variable. This means the application cannot find the display to show itself on.
117+
118+
119+
Suggested Fix
120+
#############
121+
122+
You can set this via :code:`export DISPLAY=:N` where :code:`:N` should be the number of your display

‎mantidimaging/gui/windows/welcome_screen/presenter.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,9 @@
1010

1111
LOG = getLogger(__name__)
1212

13-
WELCOME_LINKS = [
14-
["Homepage", "https://github.com/mantidproject/mantidimaging"],
15-
["Documentation", "https://mantidproject.github.io/mantidimaging/index.html"],
16-
]
13+
WELCOME_LINKS = [["Homepage", "https://github.com/mantidproject/mantidimaging"],
14+
["Documentation", "https://mantidproject.github.io/mantidimaging/index.html"],
15+
["Troubleshooting", "https://mantidproject.github.io/mantidimaging/troubleshooting.html"]]
1716

1817

1918
class WelcomeScreenPresenter(BasePresenter):

0 commit comments

Comments
 (0)