Comments and changelog

ecmwf · May 22, 2020 · 13e946f · 13e946f
1 parent 17560e4
commit 13e946f
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -5,7 +5,13 @@ Changelog for cfgrib
 0.9.8.2 (unreleased)
 --------------------
 
-- Nothing changed yet.
+- Add support for MULTI-FIELD messages used in some GRIB products to store
+  `u` and `v` components of wind (e.g. GFS, NAM, etc). This has been the single
+  most reported bug in *cfgrib* with two failed attempts at fixing it already.
+  Let's see if the third time's a charm. Please test!
+  See: `#45 <https://github.com/ecmwf/cfgrib/issues/45>`_,
+    `#76 <https://github.com/ecmwf/cfgrib/issues/76>`_ and
+    `#111 <https://github.com/ecmwf/cfgrib/issues/111>`_.
 
 
 0.9.8.1 (2020-03-13)

diff --git a/cfgrib/messages.py b/cfgrib/messages.py
@@ -51,7 +51,13 @@
 
 @contextlib.contextmanager
 def multi_enabled(file):
+    """Context manager that enables MULTI-FIELD support in ecCodes from a clean state"""
     eccodes.codes_grib_multi_support_on()
+    #
+    # Explicitly reset the multi_support global state that gets confused by random access
+    #
+    # @alexamici: I'm note sure this is thread-safe. See :#141
+    #
     context = eccodes.lib.codes_context_get_default()
     eccodes.lib.codes_grib_multi_support_reset_file(context, file)
     try: