Skip to content

Commit 6701c0d

Browse files
authored
Merge pull request #483 from PyAutoLabs/feature/numba-docs-deprioritize
docs: deprioritise numba in installation pages
2 parents 72c7fd9 + eac2061 commit 6701c0d

2 files changed

Lines changed: 42 additions & 56 deletions

File tree

docs/installation/conda.rst

Lines changed: 21 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -55,17 +55,32 @@ caching issues impacting the installation):
5555
5656
pip install autolens --no-cache-dir
5757
58-
You may get warnings which state something like:
58+
If pip prints warnings about dependency version conflicts, these can usually be ignored — the instructions below
59+
will identify clearly if the installation is a success.
60+
61+
If there are no errors **PyAutoLens** is installed!
62+
63+
If there is an error check out the `troubleshooting section <https://pyautolens.readthedocs.io/en/latest/installation/troubleshooting.html>`_.
64+
65+
Workspace
66+
---------
67+
68+
Next, clone the ``autolens workspace`` (the line ``--depth 1`` clones only the most recent branch on
69+
the ``autolens_workspace``, reducing the download size):
5970

6071
.. code-block:: bash
6172
62-
ERROR: autoarray 2026.4.5.3 has requirement numpy<=1.22.1, but you'll have numpy 1.22.2 which is incompatible.
63-
ERROR: numba 0.53.1 has requirement llvmlite<0.37,>=0.36.0rc1, but you'll have llvmlite 0.38.0 which is incompatible.
73+
cd /path/on/your/computer/you/want/to/put/the/autolens_workspace
74+
git clone https://github.com/Jammy2211/autolens_workspace --depth 1
75+
cd autolens_workspace
6476
65-
If you see these messages, they do not mean that the installation has failed and the instructions below will
66-
identify clearly if the installation is a success.
77+
Run the ``welcome.py`` script to get started!
6778

68-
If there are no errors (but only the warnings above) **PyAutoLens** is installed!
79+
.. code-block:: bash
80+
81+
python3 welcome.py
82+
83+
It should be clear that **PyAutoLens** runs without issue.
6984

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

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

91-
Workspace
92-
---------
93-
94-
Next, clone the ``autolens workspace`` (the line ``--depth 1`` clones only the most recent branch on
95-
the ``autolens_workspace``, reducing the download size):
96-
97-
.. code-block:: bash
98-
99-
cd /path/on/your/computer/you/want/to/put/the/autolens_workspace
100-
git clone https://github.com/Jammy2211/autolens_workspace --depth 1
101-
cd autolens_workspace
102-
103-
Run the ``welcome.py`` script to get started!
104-
105-
.. code-block:: bash
106-
107-
python3 welcome.py
108-
109-
It should be clear that **PyAutoLens** runs without issue.
110-
111-
If there is an error check out the `troubleshooting section <https://pyautolens.readthedocs.io/en/latest/installation/troubleshooting.html>`_.
112-
113106
Optional
114107
--------
115108

docs/installation/pip.rst

Lines changed: 21 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -42,17 +42,32 @@ the installation has clean dependencies):
4242
4343
pip install autolens
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 **PyAutoLens** is installed!
49+
50+
If there is an error check out the `troubleshooting section <https://pyautolens.readthedocs.io/en/latest/installation/troubleshooting.html>`_.
51+
52+
Workspace
53+
---------
54+
55+
Next, clone the ``autolens workspace`` (the line ``--depth 1`` clones only the most recent branch on
56+
the ``autolens_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/autolens_workspace
61+
git clone https://github.com/Jammy2211/autolens_workspace --depth 1
62+
cd autolens_workspace
5163
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.
64+
Run the ``welcome.py`` script to get started!
5465

55-
If there are no errors (but only the warnings above) **PyAutoLens** is installed!
66+
.. code-block:: bash
67+
68+
python3 welcome.py
69+
70+
It should be clear that **PyAutoLens** runs without issue.
5671

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

@@ -75,28 +90,6 @@ with the software and determine if it is the right software for you.
7590
If you decide that **PyAutoLens** 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://pyautolens.readthedocs.io/en/latest/installation/numba.html>`_
7792

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

0 commit comments

Comments
 (0)