Skip to content

docs: deprioritise numba in installation pages #379

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Jammy2211 merged 1 commit into from
Apr 30, 2026
Merged

docs: deprioritise numba in installation pages #379

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 21 additions & 29 deletions docs/installation/conda.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,17 +42,32 @@ caching issues impacting the installation):

pip install autogalaxy --no-cache-dir

You may get warnings which state something like:
If pip prints warnings about dependency version conflicts, these can usually be ignored — the instructions below
will identify clearly if the installation is a success.

If there are no errors **PyAutoGalaxy** is installed!

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

Workspace
---------

Next, clone the ``autogalaxy workspace`` (the line ``--depth 1`` clones only the most recent branch on
the ``autogalaxy_workspace``, reducing the download size):

.. code-block:: bash

ERROR: autoarray 2026.4.5.3 has requirement numpy<=1.22.1, but you'll have numpy 1.22.2 which is incompatible.
ERROR: numba 0.53.1 has requirement llvmlite<0.37,>=0.36.0rc1, but you'll have llvmlite 0.38.0 which is incompatible.
cd /path/on/your/computer/you/want/to/put/the/autogalaxy_workspace
git clone https://github.com/Jammy2211/autogalaxy_workspace --depth 1
cd autogalaxy_workspace

Run the ``welcome.py`` script to get started!

.. code-block:: bash

If you see these messages, they do not mean that the installation has failed and the instructions below will
identify clearly if the installation is a success.
python3 welcome.py

If there are no errors (but only the warnings above) **PyAutoGalaxy** is installed!
It should be clear that **PyAutoGalaxy** runs without issue.

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

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


Workspace
---------

Next, clone the ``autogalaxy workspace`` (the line ``--depth 1`` clones only the most recent branch on
the ``autogalaxy_workspace``, reducing the download size):

.. code-block:: bash

cd /path/on/your/computer/you/want/to/put/the/autogalaxy_workspace
git clone https://github.com/Jammy2211/autogalaxy_workspace --depth 1
cd autogalaxy_workspace

Run the ``welcome.py`` script to get started!

.. code-block:: bash

python3 welcome.py

It should be clear that **PyAutoGalaxy** runs without issue.

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

Optional
--------

Expand Down
62 changes: 1 addition & 61 deletions docs/installation/numba.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,64 +20,4 @@ If you do not have numba installed, you can do so via pip as follows:

.. code-block:: bash

pip install numba


Troubleshooting (Conda)
-----------------------

Numba can be installed as part of your conda environment, with this version of numba used when you make the
conda environment.

If you cannot get numba to install in an existing conda environment you can try creating a new one from fresh,
which is created with numba

To install (or update) numba in conda use the following command:

.. code-block:: bash

conda install numba

When you create the conda environment run the following command:

.. code-block:: bash

conda create -n autogalaxy numba astropy scikit-image scikit-learn scipy

You can then follow the standard conda installation instructions give here `<https://pyautogalaxy.readthedocs.io/en/latest/installation/conda.html>`_

Troubleshooting (Numpy)
-----------------------

The libraries ``numpy`` and ``numba`` can be installed with incompatible versions.

An error message like the one below occurs when importing **PyAutoGalaxy**:

.. code-block:: bash

Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "/home/jammy/venvs/PyAutoMay2/lib/python3.8/site-packages/autogalaxy/__init__.py", line 1, in <module>
from autoarray import preprocess
File "/home/jammy/venvs/PyAutoMay2/lib/python3.8/site-packages/autoarray/__init__.py", line 2, in <module>
from . import type
File "/home/jammy/venvs/PyAutoMay2/lib/python3.8/site-packages/autoarray/type.py", line 7, in <module>
from autoarray.mask.mask_1d import Mask1D
File "/home/jammy/venvs/PyAutoMay2/lib/python3.8/site-packages/autoarray/mask/mask_1d.py", line 8, in <module>
from autoarray.structures.arrays import array_1d_util
File "/home/jammy/venvs/PyAutoMay2/lib/python3.8/site-packages/autoarray/structures/arrays/array_1d_util.py", line 5, in <module>
from autoarray import numba_util
File "/home/jammy/venvs/PyAutoMay2/lib/python3.8/site-packages/autoarray/numba_util.py", line 2, in <module>
import numba
File "/home/jammy/venvs/PyAutoMay2/lib/python3.8/site-packages/numba/__init__.py", line 200, in <module>
_ensure_critical_deps()
File "/home/jammy/venvs/PyAutoMay2/lib/python3.8/site-packages/numba/__init__.py", line 140, in _ensure_critical_deps
raise ImportError("Numba needs NumPy 1.21 or less")
ImportError: Numba needs NumPy 1.21 or less

This can be fixed by reinstalling numpy with the version requested by the error message, in the example
numpy 1.21 (you should replace the ``==1.21.0`` with a different version if requested).

.. code-block:: bash

pip install numpy==1.21.0
pip install numba
7 changes: 0 additions & 7 deletions docs/installation/overview.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,6 @@ The installation guide for both approaches can be found at:
Users who wish to build **PyAutoGalaxy** from source (e.g. via a ``git clone``) should follow
our `building from source installation guide <https://pyautogalaxy.readthedocs.io/en/latest/installation/source.html>`_.

Known Issues
------------

There is a known issue installing **PyAutoGalaxy** via both ``conda`` and ``pip`` associated with the libraries ``llvmlite``
and ``numba``. If your installation raises an error mentioning either library, follow the instructions in
our `troubleshooting section <https://pyautogalaxy.readthedocs.io/en/latest/installation/troubleshooting.html>`_.

Dependencies
------------

Expand Down
49 changes: 21 additions & 28 deletions docs/installation/pip.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,17 +28,32 @@ the installation has clean dependencies):

pip install autogalaxy

You may get warnings which state something like:
If pip prints warnings about dependency version conflicts, these can usually be ignored — the instructions below
will identify clearly if the installation is a success.

If there are no errors **PyAutoGalaxy** is installed!

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

Workspace
---------

Next, clone the ``autogalaxy workspace`` (the line ``--depth 1`` clones only the most recent branch on
the ``autogalaxy_workspace``, reducing the download size):

.. code-block:: bash

ERROR: autoarray 2026.4.5.3 has requirement numpy<=1.22.1, but you'll have numpy 1.22.2 which is incompatible.
ERROR: numba 0.53.1 has requirement llvmlite<0.37,>=0.36.0rc1, but you'll have llvmlite 0.38.0 which is incompatible.
cd /path/on/your/computer/you/want/to/put/the/autogalaxy_workspace
git clone https://github.com/Jammy2211/autogalaxy_workspace --depth 1
cd autogalaxy_workspace

Run the ``welcome.py`` script to get started!

.. code-block:: bash

If you see these messages, they do not mean that the installation has failed and the instructions below will
identify clearly if the installation is a success.
python3 welcome.py

If there are no errors (but only the warnings above) **PyAutoGalaxy** is installed!
It should be clear that **PyAutoGalaxy** runs without issue.

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

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

Workspace
---------

Next, clone the ``autogalaxy workspace`` (the line ``--depth 1`` clones only the most recent branch on
the ``autogalaxy_workspace``, reducing the download size):

.. code-block:: bash

cd /path/on/your/computer/you/want/to/put/the/autogalaxy_workspace
git clone https://github.com/Jammy2211/autogalaxy_workspace --depth 1
cd autogalaxy_workspace

Run the ``welcome.py`` script to get started!

.. code-block:: bash

python3 welcome.py

It should be clear that **PyAutoGalaxy** runs without issue.

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

Optional
--------

Expand Down
Loading