Merge pull request #108 from sadielbartholomew/prep-release

Prepare release v3.4.0

Author: sadielbartholomew

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 ## cf-plot changelog
 
-**Current release: version `3.3.0`, released `2024-01-15`**
+**Current release: version `3.4.0`, released `2025-04-28`**
 
 *Note*: stated dates of releases correspond to the date a given
 version was tagged on GitHub. Up until 2024 some detail may
@@ -13,12 +13,37 @@ of being developed elsewhere.
 
 -----
 
-### Version `3.4.X`, first released (`3.4.0`) `????-??-??`
-
-#### Version `3.4.0`, release soon (date TBC)
-
-* New feature: `traj` method can now natively plot *single* trajectories encoded as
-  discrete sampling geometries (i.e. one-dimensional paths, having no trajectory dimension)
+### Version `3.4.X`, first released (`3.4.0`) `2025-04-28`
+
+#### Version `3.4.0`, release soon (date `2025-04-28`)
+
+* Move of codebase home from old repository location of `github.com/ajheaps/cf-plot` to
+  `github.com/NCAS-CMS/cf-plot` - the former URL will redirect for the time being
+  but cannot be guaranteed to do so in future
+* Move of home for documentation: now and going forward hosted permanently at
+  `ncas-cms.github.io/cf-plot/` with the previous documentation at root URL
+  `ajheaps.github.io/cf-plot/` frozen (no longer updated so do not consult)
+* Documentation overhaul including new responsive theme, hierarchical structuring,
+   improved navigation, listing of all examples grouped by theme with reorganisation
+   of gallery view, updates for informational pages, and more
+* New feature: `traj` method can now natively plot *single* trajectories
+(i.e. one-dimensional paths, having no trajectory dimension) encoded as
+  discrete sampling geometries (https://github.com/NCAS-CMS/cf-plot/issues/84)
+* Fix bug whereby `con` contour plot with `verbose=True` would result in
+   an `UnboundLocalError` (https://github.com/NCAS-CMS/cf-plot/issues/54)
+* Fix bug whereby plots such as with `con` using the 'merc' Mercator projection
+    would be cropped to small portion of the y axis
+    (https://github.com/NCAS-CMS/cf-plot/issues/65)
+* Fix bug whereby the colour bar would be mostly cutoff from the foot of
+  the figure for plots such as `con` contour plots when using certain projections
+  such as 'ortho', 'merc', and 'lcc' after a call to e.g. `cfp.mapset(proj='ortho')`
+  (https://github.com/NCAS-CMS/cf-plot/issues/70)
+* Fix bug whereby `con` contour plot in the 'UKCP' projection would
+     result in an `IndexError` for `blockfill=True`
+     (https://github.com/NCAS-CMS/cf-plot/issues/91) or otherwise an
+     `UnboundLocalError` (https://github.com/NCAS-CMS/cf-plot/issues/60)
+     or an `AttributeError` (https://github.com/NCAS-CMS/cf-plot/issues/59)
+     dependent on other configuration
 * Fix bug whereby `con` would result in a blank plot for rotated pole data
   requested for display on its native grid through setting of `cfp.mapset(proj="rotated")`
   (see https://github.com/NCAS-CMS/cf-plot/issues/86)
@@ -28,6 +53,15 @@ of being developed elsewhere.
 * Fix bug whereby blockfill plots (`con` with `blockfill=True`) of UGRID data in either polar
   projection (`proj="npstere"` or `proj="spstere"`) could display blacked out areas
   (see https://github.com/NCAS-CMS/cf-plot/issues/99)
+* Make consistent the defaults for `feature_zorder` and
+   `rotated_grid_thickness` plotting variables as configurable through `setvars`
+   (https://github.com/NCAS-CMS/cf-plot/issues/73)
+* Set new minimum version of dependency: `'cf-python >= 3.17.0'`
+* Set new minimum version of dependency: `'cartopy >= 0.17.0'`
+* Removed explicit (listed) dependency to `matplotlib` since this is required already by
+  existing dependency Cartopy
+* Removed explicit (listed) dependency to `scipy` since this is required already by existing
+  dependency cf-python
 
 
 ### Version `3.3.X`, first released (`3.3.0`) `2024-01-15`

cfplot/__init__.py

@@ -1,14 +1,13 @@
 """
-cf-plot is a set of Python plotting routines for the contour, vector
-and line plots that climate researchers commonly make.
+cf-plot: code-light plotting for earth science and aligned research
 
-See the cf-plot home page http://ajheaps.github.io/cf-plot for a
-gallery of plots and how to use cf-plot.
+Documentation is hosted and found at: https://ncas-cms.github.io/cf-plot/
 """
 
-__author__ = "Andy Heaps - andy.heaps@ncas.ac.uk"
-__date__ = "15th Jan 2024"
-__version__ = "3.3.0"
+__author__ = "Sadie Bartholomew, Andy Heaps"
+__maintainer__ ="Sadie Bartholomew"
+__date__ = "28th April 2025"
+__version__ = "3.4.0"
 
 from .cfplot import *  # noqa: F403, F401
 

docs/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: d05048b67f4ee87b1465c5da08a124f8
+config: f50bbcb56c7abdc10959588858763fbd
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_bfill.html

@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>_bfill &#8212; cf-plot 3.3.0 documentation</title>
+    <title>_bfill &#8212; cf-plot 3.4.0 documentation</title>
 
 
 
@@ -37,7 +37,7 @@
 <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="_static/documentation_options.js?v=3eb8911e"></script>
+    <script src="_static/documentation_options.js?v=b0e360d0"></script>
     <script src="_static/doctools.js?v=9bcbadda"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/design-tabs.js?v=f930bc37"></script>
@@ -124,7 +124,7 @@
 
 
 
-    <p class="title logo__title">cf-plot 3.3.0 documentation</p>
+    <p class="title logo__title">cf-plot 3.4.0 documentation</p>
 
 </a></div>
 

docs/_bfill_ugrid.html

@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>_bfill_ugrid &#8212; cf-plot 3.3.0 documentation</title>
+    <title>_bfill_ugrid &#8212; cf-plot 3.4.0 documentation</title>
 
 
 
@@ -37,7 +37,7 @@
 <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="_static/documentation_options.js?v=3eb8911e"></script>
+    <script src="_static/documentation_options.js?v=b0e360d0"></script>
     <script src="_static/doctools.js?v=9bcbadda"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/design-tabs.js?v=f930bc37"></script>
@@ -124,7 +124,7 @@
 
 
 
-    <p class="title logo__title">cf-plot 3.3.0 documentation</p>
+    <p class="title logo__title">cf-plot 3.4.0 documentation</p>
 
 </a></div>
 

docs/_cf_data_assign.html

@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>_cf_data_assign &#8212; cf-plot 3.3.0 documentation</title>
+    <title>_cf_data_assign &#8212; cf-plot 3.4.0 documentation</title>
 
 
 
@@ -37,7 +37,7 @@
 <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="_static/documentation_options.js?v=3eb8911e"></script>
+    <script src="_static/documentation_options.js?v=b0e360d0"></script>
     <script src="_static/doctools.js?v=9bcbadda"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/design-tabs.js?v=f930bc37"></script>
@@ -124,7 +124,7 @@
 
 
 
-    <p class="title logo__title">cf-plot 3.3.0 documentation</p>
+    <p class="title logo__title">cf-plot 3.4.0 documentation</p>
 
 </a></div>
 

docs/_check_data.html

@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>_check_data &#8212; cf-plot 3.3.0 documentation</title>
+    <title>_check_data &#8212; cf-plot 3.4.0 documentation</title>
 
 
 
@@ -37,7 +37,7 @@
 <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="_static/documentation_options.js?v=3eb8911e"></script>
+    <script src="_static/documentation_options.js?v=b0e360d0"></script>
     <script src="_static/doctools.js?v=9bcbadda"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/design-tabs.js?v=f930bc37"></script>
@@ -124,7 +124,7 @@
 
 
 
-    <p class="title logo__title">cf-plot 3.3.0 documentation</p>
+    <p class="title logo__title">cf-plot 3.4.0 documentation</p>
 
 </a></div>
 

docs/_cscale_get_map.html

@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>_cscale_get_map &#8212; cf-plot 3.3.0 documentation</title>
+    <title>_cscale_get_map &#8212; cf-plot 3.4.0 documentation</title>
 
 
 
@@ -37,7 +37,7 @@
 <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="_static/documentation_options.js?v=3eb8911e"></script>
+    <script src="_static/documentation_options.js?v=b0e360d0"></script>
     <script src="_static/doctools.js?v=9bcbadda"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/design-tabs.js?v=f930bc37"></script>
@@ -124,7 +124,7 @@
 
 
 
-    <p class="title logo__title">cf-plot 3.3.0 documentation</p>
+    <p class="title logo__title">cf-plot 3.4.0 documentation</p>
 
 </a></div>
 

docs/_dim_titles.html

@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>_dim_titles &#8212; cf-plot 3.3.0 documentation</title>
+    <title>_dim_titles &#8212; cf-plot 3.4.0 documentation</title>
 
 
 
@@ -37,7 +37,7 @@
 <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="_static/documentation_options.js?v=3eb8911e"></script>
+    <script src="_static/documentation_options.js?v=b0e360d0"></script>
     <script src="_static/doctools.js?v=9bcbadda"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/design-tabs.js?v=f930bc37"></script>
@@ -124,7 +124,7 @@
 
 
 
-    <p class="title logo__title">cf-plot 3.3.0 documentation</p>
+    <p class="title logo__title">cf-plot 3.4.0 documentation</p>
 
 </a></div>
 

docs/_gvals.html

@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>_gvals &#8212; cf-plot 3.3.0 documentation</title>
+    <title>_gvals &#8212; cf-plot 3.4.0 documentation</title>
 
 
 
@@ -37,7 +37,7 @@
 <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="_static/documentation_options.js?v=3eb8911e"></script>
+    <script src="_static/documentation_options.js?v=b0e360d0"></script>
     <script src="_static/doctools.js?v=9bcbadda"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/design-tabs.js?v=f930bc37"></script>
@@ -124,7 +124,7 @@
 
 
 
-    <p class="title logo__title">cf-plot 3.3.0 documentation</p>
+    <p class="title logo__title">cf-plot 3.4.0 documentation</p>
 
 </a></div>
 

docs/_images/ref_fig_42a.png

@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>_map_title &#8212; cf-plot 3.3.0 documentation</title>
+    <title>_map_title &#8212; cf-plot 3.4.0 documentation</title>
 
 
 
@@ -37,7 +37,7 @@
 <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="_static/documentation_options.js?v=3eb8911e"></script>
+    <script src="_static/documentation_options.js?v=b0e360d0"></script>
     <script src="_static/doctools.js?v=9bcbadda"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/design-tabs.js?v=f930bc37"></script>
@@ -124,7 +124,7 @@
 
 
 
-    <p class="title logo__title">cf-plot 3.3.0 documentation</p>
+    <p class="title logo__title">cf-plot 3.4.0 documentation</p>
 
 </a></div>
 

docs/_map_title.html

@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>_mapaxis &#8212; cf-plot 3.3.0 documentation</title>
+    <title>_mapaxis &#8212; cf-plot 3.4.0 documentation</title>
 
 
 
@@ -37,7 +37,7 @@
 <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="_static/documentation_options.js?v=3eb8911e"></script>
+    <script src="_static/documentation_options.js?v=b0e360d0"></script>
     <script src="_static/doctools.js?v=9bcbadda"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/design-tabs.js?v=f930bc37"></script>
@@ -124,7 +124,7 @@
 
 
 
-    <p class="title logo__title">cf-plot 3.3.0 documentation</p>
+    <p class="title logo__title">cf-plot 3.4.0 documentation</p>
 
 </a></div>