nctoolkit 1.1.6__tar.gz → 1.1.7__tar.gz

{nctoolkit-1.1.6 → nctoolkit-1.1.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: nctoolkit
-Version: 1.1.6
+Version: 1.1.7
 Summary: A Python package for netCDF analysis and post-processing
 Home-page: https://github.com/pmlmodelling/nctoolkit
 Author: Robert Wilson
@@ -42,7 +42,7 @@ Requires-Dist: geopandas; extra == "complete"
 
 Core abilities of nctoolkit include:
 
-  - Clipping to spatial regions
+  - Clipping to spatial region
   - Calculating climatologies
   - Subsetting to specific time periods
   - Calculating spatial statistics

{nctoolkit-1.1.6 → nctoolkit-1.1.7}/nctoolkit/meridonials.py

@@ -5,9 +5,7 @@ def zonstat(self, stat="mean"):
     """Method to calculate the meridonial statistic from a netCDF file"""
     for ff in self:
         if is_curvilinear(ff):
-            raise TypeError(
-                f"meridonal_{stat} cannot be calculated for curvilinear grids."
-            )
+            raise TypeError(f"meridonial_{stat} cannot be calculated for this grid type. Please consider using to_latlon to convert to a regular grid.")
     cdo_command = f"-mer{stat}"
 
     self.cdo_command(cdo_command, ensemble=False)

{nctoolkit-1.1.6 → nctoolkit-1.1.7}/nctoolkit/mp_adders.py

@@ -41,7 +41,7 @@ def match_points(
         monthly dataset.
         This is equivalent to apply `ds.tmean(..)` to the dataset.
     nan: float or list
-        Value or range of values to set to nan. Defaults to 0.
+        Value or range of values to set to nan. Defaults to None, so no values will bre reset to nan.
         Only required if values in dataset need changed to missing
     top: bool
         Set to True if you want only the top/surface level of the dataset to be selected for matching.

{nctoolkit-1.1.6 → nctoolkit-1.1.7}/nctoolkit/static_plot.py

@@ -84,7 +84,6 @@ def pub_plot(
     norm=None,
     limits=None,
     projection="auto",
-    mid_point=None,
     coast="auto",
     scale="auto",
     grid=True,
@@ -120,10 +119,13 @@ def pub_plot(
         Character string with colour map to use. Set to None if you do not want to use a colour map.
     norm: str or matplotlib.colors norm
          Norm to use for colour bar
+    limits: list
+        List with [min, max] for colour bar limits.
+        Please note that if the colour scale passes through zero, the colour scale will be symmetrical around zero.
+        So the limits will be reset to the maximum absolute value of the data.
+
     projection: cartopy projection
         Cartopy projection to use.
-    mid_point: float
-        Mid-point to use for colour bar
     coast: str
         Set to "coarse", "low", "intermediate", "high" or "full" if you want to use GSHHS coastlines
     scale: str
@@ -144,6 +146,7 @@ def pub_plot(
 
     -------------
     """
+    mid_point = None
 
     relief = False
     # check if relief is in kwargs
@@ -239,10 +242,10 @@ def pub_plot(
                 norm = kwargs[kk]
                 fixed = True
 
-        if kk.lower().startswith("mid") and kk.lower().endswith("nt"):
-            if mid_point is None:
-                mid_point = kwargs[kk]
-                fixed = True
+        #if kk.lower().startswith("mid") and kk.lower().endswith("nt"):
+        #    if mid_point is None:
+        #        mid_point = kwargs[kk]
+        #        fixed = True
 
         if kk.lower().startswith("proj"):
             if projection == "auto":
@@ -459,23 +462,6 @@ def pub_plot(
             if r_max is not None:
                 max_value = np.nanpercentile(np.ma.filled(values, np.nan), r_max)
 
-        if limits is not None and colours == "auto":
-            try:
-                if limits[0] < 0 and limits[1] > 0:
-                    min_value = limits[0]
-                    max_value = limits[1]
-                    if mid_point is None:
-                        mid_point = 0
-                    if colours == "auto":
-                        colours = "RdBu_r"
-                        if land_auto and land is not None:
-                            if land != "auto":
-                                land = "grey"
-            except:
-                pass
-
-        if colours == "auto":
-            colours = "viridis"
 
     # generate the figure and the axes where to plot the map. When the axes are generated (either with add_subplot or add_axes, or any other way), the projection to be used need to be specified
     # the axes generated show the entire globe up to the cutoff latitude
@@ -522,6 +508,37 @@ def pub_plot(
                 vmin = np.nanpercentile(np.ma.filled(values, np.nan), r_min)
             if r_max is not None:
                 vmax = np.nanpercentile(np.ma.filled(values, np.nan), r_max)
+            
+        if mid_point is None:
+            if vmin < 0 and vmax > 0:
+                mid_point = 0
+                limits[0] = vmin
+                limits[1] = vmax
+                try:
+                    if limits[0] < 0 and limits[1] > 0:
+                        min_value = limits[0]
+                        max_value = limits[1]
+                        if mid_point is None:
+                            mid_point = 0
+                        if colours == "auto":
+                            colours = "RdBu_r"
+                            if land_auto and land is not None:
+                                if land != "auto":
+                                    land = "grey"
+                except:
+                    pass
+
+        if mid_point is not None and limits is not None:
+            try:
+                if colours == "auto":
+                    colours = "RdBu_r"
+                    if land_auto and land is not None:
+                        if land != "auto":
+                            land = "grey"
+            except:
+                pass
+
+
 
         if mid_point is not None:
             val_min = values.min()
@@ -541,6 +558,10 @@ def pub_plot(
             adjustment = max(val_max - mid_point, mid_point - val_min)
             vmin = mid_point - adjustment
             vmax = mid_point + adjustment
+            # else:
+            #     print(limits)
+            #     vmin = limits[0]
+            #     vmax = limits[1]
 
         norm_plot = False
         if norm in ["log", "log10"]:
@@ -550,6 +571,31 @@ def pub_plot(
             vmin = None
             vmax = None
 
+        if limits is not None and colours == "auto":
+            try:
+                if limits[0] < 0 and limits[1] > 0:
+                    min_value = limits[0]
+                    max_value = limits[1]
+                    if mid_point is None:
+                        mid_point = 0
+                    if colours == "auto":
+                        colours = "RdBu_r"
+                        if land_auto and land is not None:
+                            if land != "auto":
+                                land = "grey"
+                else:
+                    colours = "viridis"
+            except:
+                pass
+
+        if colours == "auto":
+            colours = "viridis"
+
+        if vmin < 0 and vmax >0:
+            # ensure vmin and vmax are symmetric
+            vmax = max(abs(vmin), abs(vmax))
+            vmin = -vmax
+
         im = ax.pcolormesh(
             lon,
             lat,
@@ -562,6 +608,7 @@ def pub_plot(
             vmax=vmax,
         )
 
+
     # add coastline and land colour. More options, including about resolution of coastline, colour and so on can be found here
     # https://scitools.org.uk/cartopy/docs/v0.14/matplotlib/feature_interface.html
     #

{nctoolkit-1.1.6 → nctoolkit-1.1.7}/nctoolkit/zonals.py

@@ -7,7 +7,7 @@ def zonstat(self, stat="mean"):
 
     for ff in self:
         if is_curvilinear(ff):
-            raise TypeError(f"zonal_{stat} cannot be calculated for curvilinear grids.")
+            raise TypeError(f"zonal_{stat} cannot be calculated for this grid type. Please consider using to_latlon to convert to a regular grid.")
 
     cdo_command = f"-zon{stat}"
 

{nctoolkit-1.1.6 → nctoolkit-1.1.7}/setup.py

@@ -8,7 +8,7 @@ LONG_DESCRIPTION = """
 
 Core abilities of nctoolkit include:
 
-  - Clipping to spatial regions
+  - Clipping to spatial region
   - Calculating climatologies
   - Subsetting to specific time periods
   - Calculating spatial statistics
@@ -47,7 +47,7 @@ extras_require["complete"] = ["geoviews", "rioxarray", "cfchecker", "geocube", "
 REQUIREMENTS = [i.strip() for i in open("requirements.txt").readlines()]
 
 setup(name='nctoolkit',
-      version='1.1.6',
+      version='1.1.7',
       description=DESCRIPTION,
       long_description=LONG_DESCRIPTION,
       python_requires='>=3.6.1',