Skip to content

Commit 4d067a0

Browse files
Jammy2211Jammy2211
Jammy2211
authored and
Jammy2211
committed
docs: deprioritise numba in installation pages
Move the dedicated Numba section to sit after Workspace in pip and conda install pages, and drop the stale numba/llvmlite dependency-conflict warning example from the install snippet. Also remove the prominent "Known Issues" callout in the installation overview (numba/llvmlite is no longer a chronic install problem) and the standalone numba.rst page's troubleshooting subsections, which referenced Python 3.8 / NumPy 1.21 — versions no longer supported. Refs PyAutoLabs/PyAutoLens#482
1 parent 8c1b790 commit 4d067a0

4 files changed

Lines changed: 43 additions & 125 deletions

File tree

‎docs/installation/conda.rst‎

Lines changed: 21 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -42,17 +42,32 @@ caching issues impacting the installation):
4242
4343
pip install autogalaxy --no-cache-dir
4444
45-
You may get warnings which state something like:
45+
If pip prints warnings about dependency version conflicts, these can usually be ignored — the instructions below
46+
will identify clearly if the installation is a success.
47+
48+
If there are no errors **PyAutoGalaxy** is installed!
49+
50+
If there is an error check out the `troubleshooting section <https://pyautogalaxy.readthedocs.io/en/latest/installation/troubleshooting.html>`_.
51+
52+
Workspace
53+
---------
54+
55+
Next, clone the ``autogalaxy workspace`` (the line ``--depth 1`` clones only the most recent branch on
56+
the ``autogalaxy_workspace``, reducing the download size):
4657

4758
.. code-block:: bash
4859
49-
ERROR: autoarray 2026.4.5.3 has requirement numpy<=1.22.1, but you'll have numpy 1.22.2 which is incompatible.
50-
ERROR: numba 0.53.1 has requirement llvmlite<0.37,>=0.36.0rc1, but you'll have llvmlite 0.38.0 which is incompatible.
60+
cd /path/on/your/computer/you/want/to/put/the/autogalaxy_workspace
61+
git clone https://github.com/Jammy2211/autogalaxy_workspace --depth 1
62+
cd autogalaxy_workspace
63+
64+
Run the ``welcome.py`` script to get started!
65+
66+
.. code-block:: bash
5167
52-
If you see these messages, they do not mean that the installation has failed and the instructions below will
53-
identify clearly if the installation is a success.
68+
python3 welcome.py
5469
55-
If there are no errors (but only the warnings above) **PyAutoGalaxy** is installed!
70+
It should be clear that **PyAutoGalaxy** runs without issue.
5671

5772
If there is an error check out the `troubleshooting section <https://pyautogalaxy.readthedocs.io/en/latest/installation/troubleshooting.html>`_.
5873

@@ -75,29 +90,6 @@ with the software and determine if it is the right software for you.
7590
If you decide that **PyAutoGalaxy** is the right software, then I recommend you commit the time to getting a
7691
successful numba install working, with more information provided `at this readthedocs page <https://pyautogalaxy.readthedocs.io/en/latest/installation/numba.html>`_
7792

78-
79-
Workspace
80-
---------
81-
82-
Next, clone the ``autogalaxy workspace`` (the line ``--depth 1`` clones only the most recent branch on
83-
the ``autogalaxy_workspace``, reducing the download size):
84-
85-
.. code-block:: bash
86-
87-
cd /path/on/your/computer/you/want/to/put/the/autogalaxy_workspace
88-
git clone https://github.com/Jammy2211/autogalaxy_workspace --depth 1
89-
cd autogalaxy_workspace
90-
91-
Run the ``welcome.py`` script to get started!
92-
93-
.. code-block:: bash
94-
95-
python3 welcome.py
96-
97-
It should be clear that **PyAutoGalaxy** runs without issue.
98-
99-
If there is an error check out the `troubleshooting section <https://pyautogalaxy.readthedocs.io/en/latest/installation/troubleshooting.html>`_.
100-
10193
Optional
10294
--------
10395

‎docs/installation/numba.rst‎

Lines changed: 1 addition & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -20,64 +20,4 @@ If you do not have numba installed, you can do so via pip as follows:
2020

2121
.. code-block:: bash
2222
23-
pip install numba
24-
25-
26-
Troubleshooting (Conda)
27-
-----------------------
28-
29-
Numba can be installed as part of your conda environment, with this version of numba used when you make the
30-
conda environment.
31-
32-
If you cannot get numba to install in an existing conda environment you can try creating a new one from fresh,
33-
which is created with numba
34-
35-
To install (or update) numba in conda use the following command:
36-
37-
.. code-block:: bash
38-
39-
conda install numba
40-
41-
When you create the conda environment run the following command:
42-
43-
.. code-block:: bash
44-
45-
conda create -n autogalaxy numba astropy scikit-image scikit-learn scipy
46-
47-
You can then follow the standard conda installation instructions give here `<https://pyautogalaxy.readthedocs.io/en/latest/installation/conda.html>`_
48-
49-
Troubleshooting (Numpy)
50-
-----------------------
51-
52-
The libraries ``numpy`` and ``numba`` can be installed with incompatible versions.
53-
54-
An error message like the one below occurs when importing **PyAutoGalaxy**:
55-
56-
.. code-block:: bash
57-
58-
Traceback (most recent call last):
59-
File "<stdin>", line 1, in <module>
60-
File "/home/jammy/venvs/PyAutoMay2/lib/python3.8/site-packages/autogalaxy/__init__.py", line 1, in <module>
61-
from autoarray import preprocess
62-
File "/home/jammy/venvs/PyAutoMay2/lib/python3.8/site-packages/autoarray/__init__.py", line 2, in <module>
63-
from . import type
64-
File "/home/jammy/venvs/PyAutoMay2/lib/python3.8/site-packages/autoarray/type.py", line 7, in <module>
65-
from autoarray.mask.mask_1d import Mask1D
66-
File "/home/jammy/venvs/PyAutoMay2/lib/python3.8/site-packages/autoarray/mask/mask_1d.py", line 8, in <module>
67-
from autoarray.structures.arrays import array_1d_util
68-
File "/home/jammy/venvs/PyAutoMay2/lib/python3.8/site-packages/autoarray/structures/arrays/array_1d_util.py", line 5, in <module>
69-
from autoarray import numba_util
70-
File "/home/jammy/venvs/PyAutoMay2/lib/python3.8/site-packages/autoarray/numba_util.py", line 2, in <module>
71-
import numba
72-
File "/home/jammy/venvs/PyAutoMay2/lib/python3.8/site-packages/numba/__init__.py", line 200, in <module>
73-
_ensure_critical_deps()
74-
File "/home/jammy/venvs/PyAutoMay2/lib/python3.8/site-packages/numba/__init__.py", line 140, in _ensure_critical_deps
75-
raise ImportError("Numba needs NumPy 1.21 or less")
76-
ImportError: Numba needs NumPy 1.21 or less
77-
78-
This can be fixed by reinstalling numpy with the version requested by the error message, in the example
79-
numpy 1.21 (you should replace the ``==1.21.0`` with a different version if requested).
80-
81-
.. code-block:: bash
82-
83-
pip install numpy==1.21.0
23+
pip install numba

‎docs/installation/overview.rst‎

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,6 @@ The installation guide for both approaches can be found at:
2020
Users who wish to build **PyAutoGalaxy** from source (e.g. via a ``git clone``) should follow
2121
our `building from source installation guide <https://pyautogalaxy.readthedocs.io/en/latest/installation/source.html>`_.
2222

23-
Known Issues
24-
------------
25-
26-
There is a known issue installing **PyAutoGalaxy** via both ``conda`` and ``pip`` associated with the libraries ``llvmlite``
27-
and ``numba``. If your installation raises an error mentioning either library, follow the instructions in
28-
our `troubleshooting section <https://pyautogalaxy.readthedocs.io/en/latest/installation/troubleshooting.html>`_.
29-
3023
Dependencies
3124
------------
3225

‎docs/installation/pip.rst‎

Lines changed: 21 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -28,17 +28,32 @@ the installation has clean dependencies):
2828
2929
pip install autogalaxy
3030
31-
You may get warnings which state something like:
31+
If pip prints warnings about dependency version conflicts, these can usually be ignored — the instructions below
32+
will identify clearly if the installation is a success.
33+
34+
If there are no errors **PyAutoGalaxy** is installed!
35+
36+
If there is an error check out the `troubleshooting section <https://pyautogalaxy.readthedocs.io/en/latest/installation/troubleshooting.html>`_.
37+
38+
Workspace
39+
---------
40+
41+
Next, clone the ``autogalaxy workspace`` (the line ``--depth 1`` clones only the most recent branch on
42+
the ``autogalaxy_workspace``, reducing the download size):
3243

3344
.. code-block:: bash
3445
35-
ERROR: autoarray 2026.4.5.3 has requirement numpy<=1.22.1, but you'll have numpy 1.22.2 which is incompatible.
36-
ERROR: numba 0.53.1 has requirement llvmlite<0.37,>=0.36.0rc1, but you'll have llvmlite 0.38.0 which is incompatible.
46+
cd /path/on/your/computer/you/want/to/put/the/autogalaxy_workspace
47+
git clone https://github.com/Jammy2211/autogalaxy_workspace --depth 1
48+
cd autogalaxy_workspace
49+
50+
Run the ``welcome.py`` script to get started!
51+
52+
.. code-block:: bash
3753
38-
If you see these messages, they do not mean that the installation has failed and the instructions below will
39-
identify clearly if the installation is a success.
54+
python3 welcome.py
4055
41-
If there are no errors (but only the warnings above) **PyAutoGalaxy** is installed!
56+
It should be clear that **PyAutoGalaxy** runs without issue.
4257

4358
If there is an error check out the `troubleshooting section <https://pyautogalaxy.readthedocs.io/en/latest/installation/troubleshooting.html>`_.
4459

@@ -61,28 +76,6 @@ with the software and determine if it is the right software for you.
6176
If you decide that **PyAutoGalaxy** is the right software, then I recommend you commit the time to getting a
6277
successful numba install working, with more information provided `at this readthedocs page <https://pyautogalaxy.readthedocs.io/en/latest/installation/numba.html>`_
6378

64-
Workspace
65-
---------
66-
67-
Next, clone the ``autogalaxy workspace`` (the line ``--depth 1`` clones only the most recent branch on
68-
the ``autogalaxy_workspace``, reducing the download size):
69-
70-
.. code-block:: bash
71-
72-
cd /path/on/your/computer/you/want/to/put/the/autogalaxy_workspace
73-
git clone https://github.com/Jammy2211/autogalaxy_workspace --depth 1
74-
cd autogalaxy_workspace
75-
76-
Run the ``welcome.py`` script to get started!
77-
78-
.. code-block:: bash
79-
80-
python3 welcome.py
81-
82-
It should be clear that **PyAutoGalaxy** runs without issue.
83-
84-
If there is an error check out the `troubleshooting section <https://pyautogalaxy.readthedocs.io/en/latest/installation/troubleshooting.html>`_.
85-
8679
Optional
8780
--------
8881

0 commit comments

Comments
 (0)