cf-plot 3.5.0__tar.gz → 3.6.0__tar.gz

{cf_plot-3.5.0 → cf_plot-3.6.0}/PKG-INFO

@@ -1,31 +1,44 @@
 Metadata-Version: 2.4
 Name: cf-plot
-Version: 3.5.0
+Version: 3.6.0
 Summary: Code-light plotting for earth science and aligned research
-Author-email: Andy Heaps <andy.heaps@ncas.ac.uk>
+Author: Andy Heaps, Bryan Lawrence
+Author-email: Sadie Bartholomew <sadie.bartholomew@ncas.ac.uk>
 Maintainer-email: Sadie Bartholomew <sadie.bartholomew@ncas.ac.uk>
 License-Expression: MIT
 Project-URL: Homepage, https://ncas-cms.github.io/cf-plot/
+Project-URL: Documentation, https://ncas-cms.github.io/cf-plot/
+Project-URL: Source, https://github.com/NCAS-CMS/cf-plot
+Project-URL: Download, https://pypi.org/project/cf-plot/
+Project-URL: Installation, https://ncas-cms.github.io/cf-plot/installation.html
+Project-URL: Release Notes, https://github.com/NCAS-CMS/cf-plot/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/NCAS-CMS/cf-plot/issues
+Keywords: visualisation,visualization,scientific-visualisation,scientific-visualization,atmospheric-science,meteorology,earth-science,climate-science,geoscience,oceanography,cartography,cf-conventions,cf,data-analysis,netcdf,zarr
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Operating System :: Unix
 Classifier: Operating System :: POSIX
 Classifier: Operating System :: POSIX :: Linux
 Classifier: Operating System :: MacOS :: MacOS X
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
-Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
 Classifier: Topic :: Scientific/Engineering
 Classifier: Topic :: Scientific/Engineering :: Visualization
 Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
-Requires-Python: >=3.10
+Classifier: Topic :: Scientific/Engineering :: Oceanography
+Classifier: Topic :: Scientific/Engineering :: Hydrology
+Classifier: Topic :: Scientific/Engineering :: Chemistry
+Classifier: Topic :: Scientific/Engineering :: Physics
+Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 Requires-Dist: cf-python>=3.17.0
-Requires-Dist: scipy>=1.4.0
 Requires-Dist: cartopy>=0.22.0
 Dynamic: license-file
 
@@ -100,6 +113,45 @@ More detail about installation is provided on the
 (`https://ncas-cms.github.io/cf-plot/installation.html`)
 of the documentation.
 
+### Testing
+
+To run the full test suite, call from the repo root:
+
+``` bash
+$ pytest tests
+```
+
+Note however this calls image comparison testing on plot outputs and exact
+image comparison depends on the environment (libraries and versions) used.
+So they may fail if your environment differs from that which was used to
+generate the reference images. Therefore, to allow like-for-like comparison,
+a specific testing conda environment is provided, ``cfplot-test-env.yml``.
+With this environment enabled, the image comparison should pass. Note we
+recommend use of `mamba` for environment creation/solving, but `conda`
+will also work.
+
+```console
+$ # Deactivate all other environments present first
+$ mamba env create --file cfplot-test-env.yml --name cfplot-test-env
+$ conda activate cfplot-test-env
+$ pytest tests
+```
+
+However you can disable this aspect with the ``--skip-image-comparison``
+or equivalently ``-I`` option to the cf-plot test suite run with `pytest`,
+so that only the functional tests run. This is advised when you use any
+environment other than the above, except where some library version
+differs for the purpose of regression testing on that versioning change.
+
+```console
+$ pytest tests -I
+```
+
+> [!NOTE]
+> More comprehensive testing across different environments is under development
+> but is not yet available. For now, use the reference environment to test with.
+
+
 ### Contributing
 
 Everyone is welcome to contribute to cf-plot in the form

cf_plot-3.5.0/cf_plot.egg-info/PKG-INFO → cf_plot-3.6.0/README.md

@@ -1,34 +1,3 @@
-Metadata-Version: 2.4
-Name: cf-plot
-Version: 3.5.0
-Summary: Code-light plotting for earth science and aligned research
-Author-email: Andy Heaps <andy.heaps@ncas.ac.uk>
-Maintainer-email: Sadie Bartholomew <sadie.bartholomew@ncas.ac.uk>
-License-Expression: MIT
-Project-URL: Homepage, https://ncas-cms.github.io/cf-plot/
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Operating System :: Unix
-Classifier: Operating System :: POSIX
-Classifier: Operating System :: POSIX :: Linux
-Classifier: Operating System :: MacOS :: MacOS X
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.14
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Topic :: Scientific/Engineering
-Classifier: Topic :: Scientific/Engineering :: Visualization
-Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE.txt
-Requires-Dist: cf-python>=3.17.0
-Requires-Dist: scipy>=1.4.0
-Requires-Dist: cartopy>=0.22.0
-Dynamic: license-file
-
 # cf-plot
 
 ## Code-light plotting for earth science and aligned research
@@ -100,6 +69,45 @@ More detail about installation is provided on the
 (`https://ncas-cms.github.io/cf-plot/installation.html`)
 of the documentation.
 
+### Testing
+
+To run the full test suite, call from the repo root:
+
+``` bash
+$ pytest tests
+```
+
+Note however this calls image comparison testing on plot outputs and exact
+image comparison depends on the environment (libraries and versions) used.
+So they may fail if your environment differs from that which was used to
+generate the reference images. Therefore, to allow like-for-like comparison,
+a specific testing conda environment is provided, ``cfplot-test-env.yml``.
+With this environment enabled, the image comparison should pass. Note we
+recommend use of `mamba` for environment creation/solving, but `conda`
+will also work.
+
+```console
+$ # Deactivate all other environments present first
+$ mamba env create --file cfplot-test-env.yml --name cfplot-test-env
+$ conda activate cfplot-test-env
+$ pytest tests
+```
+
+However you can disable this aspect with the ``--skip-image-comparison``
+or equivalently ``-I`` option to the cf-plot test suite run with `pytest`,
+so that only the functional tests run. This is advised when you use any
+environment other than the above, except where some library version
+differs for the purpose of regression testing on that versioning change.
+
+```console
+$ pytest tests -I
+```
+
+> [!NOTE]
+> More comprehensive testing across different environments is under development
+> but is not yet available. For now, use the reference environment to test with.
+
+
 ### Contributing
 
 Everyone is welcome to contribute to cf-plot in the form

cf_plot-3.6.0/cf_plot.egg-info/PKG-INFO

@@ -0,0 +1,169 @@
+Metadata-Version: 2.4
+Name: cf-plot
+Version: 3.6.0
+Summary: Code-light plotting for earth science and aligned research
+Author: Andy Heaps, Bryan Lawrence
+Author-email: Sadie Bartholomew <sadie.bartholomew@ncas.ac.uk>
+Maintainer-email: Sadie Bartholomew <sadie.bartholomew@ncas.ac.uk>
+License-Expression: MIT
+Project-URL: Homepage, https://ncas-cms.github.io/cf-plot/
+Project-URL: Documentation, https://ncas-cms.github.io/cf-plot/
+Project-URL: Source, https://github.com/NCAS-CMS/cf-plot
+Project-URL: Download, https://pypi.org/project/cf-plot/
+Project-URL: Installation, https://ncas-cms.github.io/cf-plot/installation.html
+Project-URL: Release Notes, https://github.com/NCAS-CMS/cf-plot/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/NCAS-CMS/cf-plot/issues
+Keywords: visualisation,visualization,scientific-visualisation,scientific-visualization,atmospheric-science,meteorology,earth-science,climate-science,geoscience,oceanography,cartography,cf-conventions,cf,data-analysis,netcdf,zarr
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Operating System :: Unix
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
+Classifier: Topic :: Scientific/Engineering :: Oceanography
+Classifier: Topic :: Scientific/Engineering :: Hydrology
+Classifier: Topic :: Scientific/Engineering :: Chemistry
+Classifier: Topic :: Scientific/Engineering :: Physics
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: cf-python>=3.17.0
+Requires-Dist: cartopy>=0.22.0
+Dynamic: license-file
+
+# cf-plot
+
+## Code-light plotting for earth science and aligned research
+
+### Overview
+
+![cf-plot example gallery of plots](docs/source/images/new_gallery_view.png "Examples Gallery of plots made with the cf-plot library")
+
+**cf-plot allows you to produce and customise publication-quality contour,
+vector, line and more plots with the power of Python,
+[matplotlib](https://matplotlib.org/),
+[Cartopy](https://scitools.org.uk/cartopy/docs/latest/) and
+[cf-python](https://ncas-cms.github.io/cf-python/), in as few lines of code
+as possible.**
+
+It is designed to be a useful visualisation tool for environmental, earth
+and aligned sciences, for example to facilitate climate and meteorological
+research. cf-plot is developed and maintained by the
+[NCAS-CMS](https://cms.ncas.ac.uk/index.html) group, part of
+[NCAS](https://ncas.ac.uk/).
+
+
+### Brief Demonstration
+
+In as little as four lines of Python including imports and file reading,
+using `cf-plot` you can for example produce a contour plot showing a 2D
+subspace of a netCDF dataset:
+
+```python
+import cf
+import cfplot as cfp
+f = cf.read('<dataset name>.nc')[0]  # picks out a read-in field of the dataset
+cfp.con(f.subspace(time=<chosen time value>))  # creates a contour plot of the field at that time value
+```
+
+
+### Examples Gallery
+
+A gallery of outputs made with cf-plot, showcasing a range of plotting
+possibilities with links to relevant documentation pages and to example code,
+can be found
+[on this dedicated page within the documentation](https://ncas-cms.github.io/cf-plot/gallery_of_examples.html),
+as illustrated in the (static) image at the top of this document.
+
+
+### Documentation
+
+See [the cf-plot homepage](https://ncas-cms.github.io/cf-plot/)
+(`https://ncas-cms.github.io/cf-plot`) for the full online documentation.
+
+
+### Installation
+
+To install cf-plot with its required dependencies, you can use `pip`:
+
+```bash
+pip install cf-python cf-plot
+```
+
+or you can use `conda` (or similar package managers such
+as `mamba`) as follows (or equivalent):
+
+```bash
+conda install -c ncas -c conda-forge cf-python cf-plot udunits2
+```
+
+More detail about installation is provided on the
+[installation page](https://ncas-cms.github.io/cf-plot/installation.html)
+(`https://ncas-cms.github.io/cf-plot/installation.html`)
+of the documentation.
+
+### Testing
+
+To run the full test suite, call from the repo root:
+
+``` bash
+$ pytest tests
+```
+
+Note however this calls image comparison testing on plot outputs and exact
+image comparison depends on the environment (libraries and versions) used.
+So they may fail if your environment differs from that which was used to
+generate the reference images. Therefore, to allow like-for-like comparison,
+a specific testing conda environment is provided, ``cfplot-test-env.yml``.
+With this environment enabled, the image comparison should pass. Note we
+recommend use of `mamba` for environment creation/solving, but `conda`
+will also work.
+
+```console
+$ # Deactivate all other environments present first
+$ mamba env create --file cfplot-test-env.yml --name cfplot-test-env
+$ conda activate cfplot-test-env
+$ pytest tests
+```
+
+However you can disable this aspect with the ``--skip-image-comparison``
+or equivalently ``-I`` option to the cf-plot test suite run with `pytest`,
+so that only the functional tests run. This is advised when you use any
+environment other than the above, except where some library version
+differs for the purpose of regression testing on that versioning change.
+
+```console
+$ pytest tests -I
+```
+
+> [!NOTE]
+> More comprehensive testing across different environments is under development
+> but is not yet available. For now, use the reference environment to test with.
+
+
+### Contributing
+
+Everyone is welcome to contribute to cf-plot in the form
+of bug reports, documentation, code, design proposals, and more.
+
+Contributing guidelines are available in a
+[dedicated document](https://github.com/NCAS-CMS/cf-plot/blob/main/.github/CONTRIBUTING.md) which is
+copied into the [documentation here](https://ncas-cms.github.io/cf-plot/support.html#contributing-to-cf-plot).
+
+
+### Help: Issues, Questions, Feature Requests, etc.
+
+For any queries, see the
+[guidance page](https://ncas-cms.github.io/cf-plot/support.html)
+(`https://ncas-cms.github.io/cf-plot/support.html`).

{cf_plot-3.5.0 → cf_plot-3.6.0}/cf_plot.egg-info/requires.txt

@@ -1,3 +1,2 @@
 cf-python>=3.17.0
-scipy>=1.4.0
 cartopy>=0.22.0

{cf_plot-3.5.0 → cf_plot-3.6.0}/cfplot/__init__.py

@@ -7,22 +7,33 @@ Documentation is hosted and found at: https://ncas-cms.github.io/cf-plot/
 from .colorbar import cbar
 from .colour import cscale
 from .contour import con, levs
-from .layout_runtime import gclose, gopen, gpos, gset
-from .line import lineplot
+from .layout_runtime import axes, gclose, gfigure, gopen, gpos, gset
+from .line import lineplot, scatter
 from .map_runtime import mapset
 from .rotated_runtime import _render_rotated_grid_axes
 from .state import plotvars, reset_runtime_state, setvars
 from .stipple import stipple
 from .stream import stream
 from .trajectory import traj
+from .utility import (
+    add_cyclic,
+    calculate_levels,
+    cf_var_name,
+    cf_var_name_titles,
+    find_dim_names,
+    find_z,
+    fix_floats,
+    generate_titles,
+)
 from .utility import gvals as _gvals_impl
 from .utility import mapaxis as _mapaxis_impl
-from .utility import regrid
-from .vector import vect
+from .utility import ndecs, polar_regular_grid, regrid, stipple_points
+from .validate import check_well_formed, orca_check
+from .vector import axes_plot, vect
 
 __author__ = "Andy Heaps, Sadie Bartholomew, Bryan Lawrence"
-__maintainer__ ="Sadie Bartholomew"
-__date__ = "2026-10-09"
+__maintainer__ = "Sadie Bartholomew"
+__date__ = "2026-11-10"
 
 
 from importlib.metadata import PackageNotFoundError
@@ -33,7 +44,7 @@ from pathlib import Path
 def _version_from_pyproject():
     pyproject = Path(__file__).resolve().parent.parent / "pyproject.toml"
     if not pyproject.exists():
-        return None
+        return
 
     in_project = False
     for raw_line in pyproject.read_text(encoding="utf-8").splitlines():
@@ -47,7 +58,7 @@ def _version_from_pyproject():
             _, _, value = line.partition("=")
             return value.strip().strip('"').strip("'")
 
-    return None
+    return
 
 
 def _resolve_version():
@@ -67,6 +78,7 @@ __version__ = _resolve_version()
 
 
 def reset():
+    """Reset plotting state to the default configuration."""
     gset()
     cscale()
     levs()
@@ -76,6 +88,7 @@ def reset():
 
 
 def _gvals(*args, **kwargs):
+    """Work out a sensible set of values between two limits."""
     return _gvals_impl(*args, **kwargs)
 
 
@@ -95,6 +108,7 @@ def rgaxes(
     xlabel=None,
     ylabel=None,
 ):
+    """Label rotated grid plots."""
     return _render_rotated_grid_axes(
         xpole=xpole,
         ypole=ypole,
@@ -113,6 +127,7 @@ def rgaxes(
 
 
 def _mapaxis(min=None, max=None, type=None):
+    """Work out a sensible set of lon-lat tick marks and labels."""
     return _mapaxis_impl(
         min_val=min,
         max_val=max,
@@ -122,25 +137,42 @@ def _mapaxis(min=None, max=None, type=None):
 
 
 __all__ = [
+    "_gvals",  # Req'd for public API?
+    "_mapaxis",  # Req'd for public API?
+    "add_cyclic",
+    "axes",
+    "axes_plot",
+    "calculate_levels",
     "cbar",
+    "cf_var_name",
+    "cf_var_name_titles",
+    "check_well_formed",
     "con",
     "cscale",
+    "find_dim_names",
+    "find_z",
+    "fix_floats",
     "gclose",
+    "generate_titles",
+    "gfigure",
     "gopen",
     "gpos",
     "gset",
     "levs",
     "lineplot",
     "mapset",
+    "ndecs",
+    "orca_check",
     "plotvars",
+    "polar_regular_grid",
     "regrid",
     "reset",
     "rgaxes",
+    "scatter",
     "setvars",
     "stipple",
+    "stipple_points",
     "stream",
     "traj",
     "vect",
-    "_gvals",
-    "_mapaxis",
 ]

{cf_plot-3.5.0 → cf_plot-3.6.0}/cfplot/blockfill.py

@@ -63,19 +63,20 @@ def _bfill(
         colmap = get_colour_scale_map()
         cmap = matplotlib.colors.ListedColormap(colmap)
         fill_colors = list(colmap)
-        if plotvars.levels_extend in ["min", "both"]:
-            cmap.set_under(plotvars.cs[0])
-        if plotvars.levels_extend in ["max", "both"]:
-            cmap.set_over(plotvars.cs[-1])
 
-        under_index = None
-        over_index = None
+        extremes = {}
         if plotvars.levels_extend in ["min", "both"]:
+            extremes["under"] = plotvars.cs[0]
             under_index = len(fill_colors)
             fill_colors.append(plotvars.cs[0])
         if plotvars.levels_extend in ["max", "both"]:
+            extremes["over"] = plotvars.cs[-1]
             over_index = len(fill_colors)
             fill_colors.append(plotvars.cs[-1])
+
+        if extremes:
+            cmap = cmap.with_extremes(**extremes)
+
     else:
         cols = single_fill_color
         cmap = matplotlib.colors.ListedColormap(cols)
@@ -107,9 +108,11 @@ def _bfill(
                 colarr[pts] = np.size(levels) - 2
 
     if isinstance(field, np.ma.MaskedArray):
-        pts = np.ma.where(field.mask)
-        if np.size(pts) > 0:
-            colarr[pts] = -1
+        # np.ma.where on a scalar False mask raises on newer NumPy.
+        # Use a normalized boolean mask array instead.
+        mask = np.ma.getmaskarray(field)
+        if np.any(mask):
+            colarr[mask] = -1
 
     norm = matplotlib.colors.BoundaryNorm(levels, cmap.N)
 
@@ -447,10 +450,10 @@ def _bfill_ugrid(
 
     levs = deepcopy(np.array(clevs))
 
-    if plotvars.levels_extend == "min" or plotvars.levels_extend == "both":
+    if plotvars.levels_extend in ("min", "both"):
         levs = np.concatenate([[-1e20], levs])
     ilevs_max = np.size(levs)
-    if plotvars.levels_extend == "max" or plotvars.levels_extend == "both":
+    if plotvars.levels_extend in ("max", "both"):
         levs = np.concatenate([levs, [1e20]])
     else:
         ilevs_max = ilevs_max - 1

{cf_plot-3.5.0 → cf_plot-3.6.0}/cfplot/colorbar.py

@@ -204,15 +204,19 @@ def cbar(
         )
 
         boundaries = levs.astype(float)
+        extremes = {}
         if extend in ("both", "min"):
-            cmap.set_under(plotvars.cs[0])
+            extremes["under"] = plotvars.cs[0]
             boundaries = np.insert(boundaries, 0, boundaries[0] - 1)
         if extend in ("both", "max"):
-            cmap.set_over(plotvars.cs[-1])
+            extremes["over"] = plotvars.cs[-1]
             boundaries = np.insert(
                 boundaries, len(boundaries), boundaries[-1] + 1
             )
 
+        if extremes:
+            cmap = cmap.with_extremes(**extremes)
+
         if not isinstance(levs, list):
             lbot = None
 

{cf_plot-3.5.0 → cf_plot-3.6.0}/cfplot/colour/colour.py

@@ -668,15 +668,19 @@ def cbar(
         # Add colorbar extensions if definded by levs.  Using boundaries[0]-1
         # for the lower and boundaries[-1]+1 is just for the colorbar and
         # has no meaning for the plot.
+        extremes = {}
         if extend in ("both", "min"):
-            cmap.set_under(plotvars.cs[0])
+            extremes["under"] = plotvars.cs[0]
             boundaries = np.insert(boundaries, 0, boundaries[0] - 1)
         if extend in ("both", "max"):
-            cmap.set_over(plotvars.cs[-1])
+            extremes["over"] = plotvars.cs[-1]
             boundaries = np.insert(
                 boundaries, len(boundaries), boundaries[-1] + 1
             )
 
+        if extremes:
+            cmap = cmap.with_extremes(**extremes)
+
         if not isinstance(levs, list):
             lbot = None