Skip to content

Commit f5d5ec0

Browse files
committed
DOC: updated installation instructions
1 parent 0dedc4e commit f5d5ec0

File tree

1 file changed

+5
-9
lines changed

1 file changed

+5
-9
lines changed

docs/source/installation.rst

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,6 @@ The easiest way to install PyXRF is to load it into a Conda environment from
77
``conda-forge`` Anaconda channel. Installation instructions are
88
identical for all supported OS.
99

10-
PyXRF is currently not working properly with ``PyQt5`` v5.15, which is the latest available
11-
version. The instructions show how to install earlier version of ``PyQt5`` from PyPI.
12-
1310
.. note::
1411

1512
**Installation on Windows**: PyXRF can be installed from *conda-forge* only in the environments
@@ -36,15 +33,13 @@ version. The instructions show how to install earlier version of ``PyQt5`` from
3633
3734
$ conda install mamba -n base -c conda-forge
3835
39-
Then use `mamba` instead of `conda` in all commands. Mamba may not respect pinned versions of
40-
packages. Since PyXRF currently does not work with `pyqt` v5.15, explicitly specify the version
41-
`"pyqt<5.15"` during installation, for example
36+
Then use `mamba` instead of `conda` in all the following commands, for example
4237

4338
.. code:: bash
4439
4540
$ mamba create -n pyxrf-env python=3.9 pip -c conda-forge
4641
$ mamba activate pyxrf-env
47-
$ mamba install pyxrf "pyqt<5.15" -c conda-forge
42+
$ mamba install pyxrf -c conda-forge
4843
4944
You may still use `conda` where it works well, e.g. to activate an existing environment.
5045

@@ -119,14 +114,15 @@ version. The instructions show how to install earlier version of ``PyQt5`` from
119114

120115
.. code:: bash
121116
122-
$ pip install pyxrf 'PyQt5<5.15'
117+
$ pip install pyxrf PyQt5
118+
$ pip install pyxrf 'PyQt5<5.15' # Older version of PyQT
123119
124120
or from source (editable installation):
125121

126122
.. code:: bash
127123
128124
$ cd <root-directory-of-the-repository>
129-
$ pip install 'PyQt5<5.15'
125+
$ pip install PyQt5
130126
$ pip install -e .
131127
132128
Starting PyXRF

0 commit comments

Comments
 (0)