Skip to content

Commit c4301e3

Browse files
committed
Update README with clearer installation instructions
1 parent 1f4005a commit c4301e3

File tree

1 file changed

+28
-10
lines changed

1 file changed

+28
-10
lines changed

Diff for: README.rst

+28-10
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,11 @@ Limitations:
2424
Installation
2525
============
2626

27-
**From version 2.37.0, the ecCodes Python bindings additionally provide the ecCodes binary library, and will
27+
**From version 2.37.0, the ecCodes Python bindings on PyPi additionally provide the ecCodes binary library, and will
2828
follow the version numbering of the ecCodes binary library. See below for details.**
2929

30+
Installation from PyPI
31+
----------------------
3032

3133
The package can be installed from PyPI with::
3234

@@ -40,30 +42,37 @@ set the following environment variable before you import eccodes::
4042

4143
If this is set, the ecCodes' Python bindings will use the `findlibs <https://github.com/ecmwf/findlibs>`_ package
4244
to locate the binary library (findlibs was the only mechanism used before version 2.37.0).
43-
44-
In order to gain insights into the search for the binary library, set the following environment variable before
45-
importing eccodes::
46-
47-
$ export ECCODES_PYTHON_TRACE_LIB_SEARCH=1
4845

4946
You may also install a version of ecCodes' Python interface that does not include a binary library at all,
5047
in which case the findlibs mechanism will be used as before::
5148

5249
$ pip install eccodes --no-binary eccodes
5350

51+
See also 'Debugging the library search', below.
52+
53+
54+
Installation from conda
55+
-----------------------
56+
57+
ecCodes' Python bindings can be installed from the `conda-forge <https://conda-forge.org/>`_ channel with::
58+
59+
$ conda install -c conda-forge python-eccodes
60+
61+
This will install the Python bindings (`python-eccodes`) and also the ecCodes binary library (`eccodes`) on which they depend.
62+
5463

5564
System dependencies
5665
-------------------
5766

58-
The Python module depends on the ECMWF *ecCodes* library. From version 2.37.0, this is supplied with
59-
the Python module. If you wish to install and use a separate binary library (see above), it
60-
must be installed on the system and accessible as a shared library.
67+
The Python module depends on the ECMWF *ecCodes* binary library. From version 2.37.0, this library is supplied with
68+
the Python module on both PyPi and conda, as described above. If you wish to install and use a separate binary library
69+
(see above), it must be installed on the system and accessible as a shared library.
6170

6271
On a MacOS with HomeBrew use::
6372

6473
$ brew install eccodes
6574

66-
Or if you manage binary packages with *Conda* use::
75+
Or if you manage binary packages with *Conda* but use Python bindings from elsewhere, use::
6776

6877
$ conda install -c conda-forge eccodes
6978

@@ -78,6 +87,15 @@ You may run a simple selfcheck command to ensure that your system is set up corr
7887
Your system is ready.
7988

8089

90+
Debugging the library search
91+
----------------------------
92+
93+
In order to gain insights into the search for the binary library, set the following environment variable before
94+
importing eccodes::
95+
96+
$ export ECCODES_PYTHON_TRACE_LIB_SEARCH=1
97+
98+
8199
Usage
82100
-----
83101

0 commit comments

Comments
 (0)