eccodes 1.7.0__tar.gz → 2.37.0__tar.gz

{eccodes-1.7.0 → eccodes-2.37.0}/CHANGELOG.rst

@@ -2,8 +2,19 @@
 Changelog for eccodes-python
 ============================
 
+2.37.0 (2024-09-09)
+-------------------
+
+- bundle ecCodes binary library with the PyPi distribution, for Linux and MacOS
+
+1.7.1 (2024-06-19)
+--------------------
+
+- `np.Infinity` was removed in the NumPy 2.0 release
+
 1.7.0 (2024-02-26)
 --------------------
+
 - ECC-1761: Add function to extract message offsets and sizes
 - ECC-1742: Add function to clone only the meta-data of a message
 

{eccodes-1.7.0 → eccodes-2.37.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: eccodes
-Version: 1.7.0
+Version: 2.37.0
 Summary: Python interface to the ecCodes GRIB and BUFR decoder/encoder
 Home-page: https://github.com/ecmwf/eccodes-python
 Author: European Centre for Medium-Range Weather Forecasts (ECMWF)
@@ -49,16 +49,40 @@ Limitations:
 Installation
 ============
 
+**From version 2.37.0, the ecCodes Python bindings additionally provide the ecCodes binary library, and will
+follow the version numbering of the ecCodes binary library. See below for details.**
+
+
 The package is installed from PyPI with::
 
     $ pip install eccodes
 
+This installation will, by default, include the ecCodes binary library (as of version 2.37.0), meaning that no
+external ecCodes binary library is required. If you have an external ecCodes binary library that you wish to use,
+set the following environment variable before you import eccodes::
+
+    $ export ECCODES_PYTHON_USE_FINDLIBS=1
+
+If this is set, the ecCodes' Python bindings will use the `findlibs <https://github.com/ecmwf/findlibs>`_ package
+to locate the binary library (findlibs was the only mechanism used before version 2.37.0).
+
+In order to gain insights into the search for the binary library, set the following environment variable before
+importing eccodes::
+
+    $ export ECCODES_PYTHON_TRACE_LIB_SEARCH=1
+ 
+You may also install a version of ecCodes' Python interface that does not include a binary library at all,
+in which case the findlibs mechanism will be used as before::
+
+    $ pip install eccodes --no-binary eccodes
+
 
 System dependencies
 -------------------
 
-The Python module depends on the ECMWF *ecCodes* library
-that must be installed on the system and accessible as a shared library.
+The Python module depends on the ECMWF *ecCodes* library. From version 2.37.0, this is supplied with
+the Python module. If you wish to install and use a separate binary library (see above), it
+must be installed on the system and accessible as a shared library.
 
 On a MacOS with HomeBrew use::
 
@@ -75,7 +99,7 @@ https://confluence.ecmwf.int/display/ECC/ecCodes+installation
 You may run a simple selfcheck command to ensure that your system is set up correctly::
 
     $ python -m eccodes selfcheck
-    Found: ecCodes v2.27.0.
+    Found: ecCodes v2.37.0.
     Your system is ready.
 
 
@@ -155,8 +179,19 @@ does it submit to any jurisdiction.
 Changelog for eccodes-python
 ============================
 
+2.37.0 (2024-09-09)
+-------------------
+
+- bundle ecCodes binary library with the PyPi distribution, for Linux and MacOS
+
+1.7.1 (2024-06-19)
+--------------------
+
+- `np.Infinity` was removed in the NumPy 2.0 release
+
 1.7.0 (2024-02-26)
 --------------------
+
 - ECC-1761: Add function to extract message offsets and sizes
 - ECC-1742: Add function to clone only the meta-data of a message
 

{eccodes-1.7.0 → eccodes-2.37.0}/README.rst

@@ -24,16 +24,40 @@ Limitations:
 Installation
 ============
 
+**From version 2.37.0, the ecCodes Python bindings additionally provide the ecCodes binary library, and will
+follow the version numbering of the ecCodes binary library. See below for details.**
+
+
 The package is installed from PyPI with::
 
     $ pip install eccodes
 
+This installation will, by default, include the ecCodes binary library (as of version 2.37.0), meaning that no
+external ecCodes binary library is required. If you have an external ecCodes binary library that you wish to use,
+set the following environment variable before you import eccodes::
+
+    $ export ECCODES_PYTHON_USE_FINDLIBS=1
+
+If this is set, the ecCodes' Python bindings will use the `findlibs <https://github.com/ecmwf/findlibs>`_ package
+to locate the binary library (findlibs was the only mechanism used before version 2.37.0).
+
+In order to gain insights into the search for the binary library, set the following environment variable before
+importing eccodes::
+
+    $ export ECCODES_PYTHON_TRACE_LIB_SEARCH=1
+ 
+You may also install a version of ecCodes' Python interface that does not include a binary library at all,
+in which case the findlibs mechanism will be used as before::
+
+    $ pip install eccodes --no-binary eccodes
+
 
 System dependencies
 -------------------
 
-The Python module depends on the ECMWF *ecCodes* library
-that must be installed on the system and accessible as a shared library.
+The Python module depends on the ECMWF *ecCodes* library. From version 2.37.0, this is supplied with
+the Python module. If you wish to install and use a separate binary library (see above), it
+must be installed on the system and accessible as a shared library.
 
 On a MacOS with HomeBrew use::
 
@@ -50,7 +74,7 @@ https://confluence.ecmwf.int/display/ECC/ecCodes+installation
 You may run a simple selfcheck command to ensure that your system is set up correctly::
 
     $ python -m eccodes selfcheck
-    Found: ecCodes v2.27.0.
+    Found: ecCodes v2.37.0.
     Your system is ready.
 
 

{eccodes-1.7.0 → eccodes-2.37.0}/eccodes.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: eccodes
-Version: 1.7.0
+Version: 2.37.0
 Summary: Python interface to the ecCodes GRIB and BUFR decoder/encoder
 Home-page: https://github.com/ecmwf/eccodes-python
 Author: European Centre for Medium-Range Weather Forecasts (ECMWF)
@@ -49,16 +49,40 @@ Limitations:
 Installation
 ============
 
+**From version 2.37.0, the ecCodes Python bindings additionally provide the ecCodes binary library, and will
+follow the version numbering of the ecCodes binary library. See below for details.**
+
+
 The package is installed from PyPI with::
 
     $ pip install eccodes
 
+This installation will, by default, include the ecCodes binary library (as of version 2.37.0), meaning that no
+external ecCodes binary library is required. If you have an external ecCodes binary library that you wish to use,
+set the following environment variable before you import eccodes::
+
+    $ export ECCODES_PYTHON_USE_FINDLIBS=1
+
+If this is set, the ecCodes' Python bindings will use the `findlibs <https://github.com/ecmwf/findlibs>`_ package
+to locate the binary library (findlibs was the only mechanism used before version 2.37.0).
+
+In order to gain insights into the search for the binary library, set the following environment variable before
+importing eccodes::
+
+    $ export ECCODES_PYTHON_TRACE_LIB_SEARCH=1
+ 
+You may also install a version of ecCodes' Python interface that does not include a binary library at all,
+in which case the findlibs mechanism will be used as before::
+
+    $ pip install eccodes --no-binary eccodes
+
 
 System dependencies
 -------------------
 
-The Python module depends on the ECMWF *ecCodes* library
-that must be installed on the system and accessible as a shared library.
+The Python module depends on the ECMWF *ecCodes* library. From version 2.37.0, this is supplied with
+the Python module. If you wish to install and use a separate binary library (see above), it
+must be installed on the system and accessible as a shared library.
 
 On a MacOS with HomeBrew use::
 
@@ -75,7 +99,7 @@ https://confluence.ecmwf.int/display/ECC/ecCodes+installation
 You may run a simple selfcheck command to ensure that your system is set up correctly::
 
     $ python -m eccodes selfcheck
-    Found: ecCodes v2.27.0.
+    Found: ecCodes v2.37.0.
     Your system is ready.
 
 
@@ -155,8 +179,19 @@ does it submit to any jurisdiction.
 Changelog for eccodes-python
 ============================
 
+2.37.0 (2024-09-09)
+-------------------
+
+- bundle ecCodes binary library with the PyPi distribution, for Linux and MacOS
+
+1.7.1 (2024-06-19)
+--------------------
+
+- `np.Infinity` was removed in the NumPy 2.0 release
+
 1.7.0 (2024-02-26)
 --------------------
+
 - ECC-1761: Add function to extract message offsets and sizes
 - ECC-1742: Add function to clone only the meta-data of a message
 

{eccodes-1.7.0 → eccodes-2.37.0}/gribapi/__init__.py

@@ -14,8 +14,8 @@ from .gribapi import *  # noqa
 from .gribapi import __version__, lib
 
 # The minimum recommended version for the ecCodes package
-min_recommended_version_str = "2.31.0"
-min_recommended_version_int = 23100
+min_recommended_version_str = "2.37.0"
+min_recommended_version_int = 23700
 
 if lib.grib_get_api_version() < min_recommended_version_int:
     import warnings

eccodes-2.37.0/gribapi/bindings.py

@@ -0,0 +1,117 @@
+#
+# (C) Copyright 2017- ECMWF.
+#
+# This software is licensed under the terms of the Apache Licence Version 2.0
+# which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# In applying this licence, ECMWF does not waive the privileges and immunities
+# granted to it by virtue of its status as an intergovernmental organisation nor
+# does it submit to any jurisdiction.
+#
+
+# Authors:
+#   Alessandro Amici - B-Open - https://bopen.eu
+#   Shahram Najm - ECMWF - https://www.ecmwf.int
+#
+
+from __future__ import absolute_import, division, print_function, unicode_literals
+
+import logging
+import os
+import pkgutil
+import sys
+
+import cffi
+
+__version__ = "2.37.0"
+
+LOG = logging.getLogger(__name__)
+
+_MAP = {
+    "grib_api": "eccodes",
+    "gribapi": "eccodes",
+}
+
+EXTENSIONS = {
+    "darwin": ".dylib",
+    "win32": ".dll",
+}
+
+# convenient way to trace the search for the library
+if int(os.environ.get("ECCODES_PYTHON_TRACE_LIB_SEARCH", "0")):
+    LOG.setLevel(logging.DEBUG)
+    LOG.addHandler(logging.StreamHandler())
+
+
+def _lookup(name):
+    return _MAP.get(name, name)
+
+
+def find_binary_libs(name):
+
+    name = _lookup(name)
+    env_var = "ECCODES_PYTHON_USE_FINDLIBS"
+    if int(os.environ.get(env_var, "0")):
+        LOG.debug(f"{name} lib search: {env_var} set, so using findlibs")
+
+    else:
+        LOG.debug(f"{name} lib search: trying to find binary wheel")
+        here = os.path.dirname(__file__)
+        # eccodes libs are actually in eccodes dir, not gribapi dir
+        here = os.path.abspath(os.path.join(here, os.path.pardir, "eccodes"))
+        extension = EXTENSIONS.get(sys.platform, ".so")
+
+        for libdir in [here + ".libs", os.path.join(here, ".dylibs"), here]:
+            LOG.debug(f"{name} lib search: looking in {libdir}")
+            if not name.startswith("lib"):
+                libnames = ["lib" + name, name]
+            else:
+                libnames = [name, name[3:]]
+
+            if os.path.exists(libdir):
+                for file in os.listdir(libdir):
+                    if file.endswith(extension):
+                        for libname in libnames:
+                            if libname == file.split("-")[0].split(".")[0]:
+                                foundlib = os.path.join(libdir, file)
+                                LOG.debug(
+                                    f"{name} lib search: returning wheel library from {foundlib}"
+                                )
+                                # force linking with the C++ 'glue' library
+                                try:
+                                    from eccodes._eccodes import versions as _versions
+                                except ImportError as e:
+                                    LOG.warn(str(e))
+                                    raise
+                                LOG.debug(
+                                    f"{name} lib search: versions: %s", _versions()
+                                )
+                                return foundlib
+
+        LOG.debug(
+            f"{name} lib search: did not find library from wheel; try to find as separate lib"
+        )
+
+    # if did not find the binary wheel, or the env var is set, fall back to findlibs
+    import findlibs
+
+    foundlib = findlibs.find(name)
+    LOG.debug(f"{name} lib search: findlibs returned {foundlib}")
+    return foundlib
+
+
+library_path = find_binary_libs("eccodes")
+
+if library_path is None:
+    raise RuntimeError("Cannot find the ecCodes library")
+
+# default encoding for ecCodes strings
+ENC = "ascii"
+
+ffi = cffi.FFI()
+CDEF = pkgutil.get_data(__name__, "grib_api.h")
+CDEF += pkgutil.get_data(__name__, "eccodes.h")
+ffi.cdef(CDEF.decode("utf-8").replace("\r", "\n"))
+
+
+lib = ffi.dlopen(library_path)

{eccodes-1.7.0 → eccodes-2.37.0}/gribapi/gribapi.py

@@ -581,7 +581,7 @@ def grib_multi_append(ingribid, startsection, multigribid):
 @require(msgid=int, key=str)
 def grib_get_size(msgid, key):
     """
-    @brief Get the size of an array key.
+    @brief Get the size of a key. Return 1 for scalar keys and >1 for array keys
 
     \b Examples: \ref grib_get_keys.py "grib_get_keys.py",\ref count_messages.py "count_messages.py"
 

{eccodes-1.7.0 → eccodes-2.37.0}/setup.py

@@ -36,6 +36,43 @@ def parse_version_from(path):
     return version_match.group(1)
 
 
+# for the binary wheel
+libdir = os.path.realpath("install/lib")
+incdir = os.path.realpath("install/include")
+libs = ["eccodes"]
+
+if "--binary-wheel" in sys.argv:
+    sys.argv.remove("--binary-wheel")
+
+    # https://setuptools.pypa.io/en/latest/userguide/ext_modules.html
+    ext_modules = [
+        setuptools.Extension(
+            "eccodes._eccodes",
+            sources=["eccodes/_eccodes.cc"],
+            language="c++",
+            libraries=libs,
+            library_dirs=[libdir],
+            include_dirs=[incdir],
+            extra_link_args=["-Wl,-rpath," + libdir],
+        )
+    ]
+
+    def shared(directory):
+        result = []
+        for path, dirs, files in os.walk(directory):
+            for f in files:
+                result.append(os.path.join(path, f))
+        return result
+
+    # Paths must be relative to package directory...
+    shared_files = ["versions.txt"]
+    shared_files += [x[len("eccodes/") :] for x in shared("eccodes/copying")]
+
+else:
+    ext_modules = []
+    shared_files = []
+
+
 install_requires = ["numpy"]
 if sys.version_info < (3, 7):
     install_requires = ["numpy<1.20"]
@@ -57,6 +94,7 @@ setuptools.setup(
     url="https://github.com/ecmwf/eccodes-python",
     packages=setuptools.find_packages(),
     include_package_data=True,
+    package_data={"": shared_files},
     install_requires=install_requires,
     tests_require=[
         "pytest",
@@ -78,4 +116,5 @@ setuptools.setup(
         "Programming Language :: Python :: Implementation :: PyPy",
         "Operating System :: OS Independent",
     ],
+    ext_modules=ext_modules,
 )

{eccodes-1.7.0 → eccodes-2.37.0}/tests/test_eccodes.py

@@ -576,7 +576,8 @@ def test_grib_ecc_1007():
 
 def test_grib_set_bitmap():
     gid = eccodes.codes_grib_new_from_samples("GRIB2")
-    missing = np.Infinity
+    # Note: np.Infinity was removed in the NumPy 2.0 release. Use np.inf instead
+    missing = np.inf
     eccodes.codes_set(gid, "bitmapPresent", 1)
     eccodes.codes_set(gid, "missingValue", missing)
     # Grid with 100 points 2 of which are missing
@@ -965,7 +966,7 @@ def test_bufr_copy_data():
 # ---------------------------------------------
 def test_grib_nearest2():
     if "codes_grib_nearest_new" not in dir(eccodes):
-        return
+        pytest.skip("codes_grib_nearest_new absent")
     gid = eccodes.codes_grib_new_from_samples("gg_sfc_grib2")
     lat, lon = 40, 20
     flags = eccodes.CODES_GRIB_NEAREST_SAME_GRID | eccodes.CODES_GRIB_NEAREST_SAME_POINT

eccodes-1.7.0/gribapi/bindings.py

@@ -1,46 +0,0 @@
-#
-# (C) Copyright 2017- ECMWF.
-#
-# This software is licensed under the terms of the Apache Licence Version 2.0
-# which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
-#
-# In applying this licence, ECMWF does not waive the privileges and immunities
-# granted to it by virtue of its status as an intergovernmental organisation nor
-# does it submit to any jurisdiction.
-#
-
-# Authors:
-#   Alessandro Amici - B-Open - https://bopen.eu
-#   Shahram Najm - ECMWF - https://www.ecmwf.int
-#
-
-from __future__ import absolute_import, division, print_function, unicode_literals
-
-import logging
-import pkgutil
-
-import cffi
-
-__version__ = "1.7.0"
-
-LOG = logging.getLogger(__name__)
-
-try:
-    import ecmwflibs as findlibs
-except ImportError:
-    import findlibs
-
-library_path = findlibs.find("eccodes")
-if library_path is None:
-    raise RuntimeError("Cannot find the ecCodes library")
-
-# default encoding for ecCodes strings
-ENC = "ascii"
-
-ffi = cffi.FFI()
-CDEF = pkgutil.get_data(__name__, "grib_api.h")
-CDEF += pkgutil.get_data(__name__, "eccodes.h")
-ffi.cdef(CDEF.decode("utf-8").replace("\r", "\n"))
-
-
-lib = ffi.dlopen(library_path)