Merge back v3p0p0 (#3960)

* Add release highlights and pin rc version (#3898) * Add release highlights and pin rc version * review actions * reorder release highlights (#3899) Tweak release highlights * Add whatsnew announcement (#3900) * Fix spelling (#3903) * Fix unit label handling (#3902) * Add failing test of plotting * Implement fix to pass test * Update idiff to ignore irrelevant hyphens in path * Update imagerepo (following docs) * Update after review by @trexfeathers * Add whatsnew entries * Move whatsnew entries into correct file * Release Docs Improvements (#3895) * Minor phrasing change in 'Release candidate'. * Before release deprecations. * Whatsnew highlights section. * Relax setup.py setup requirements (#3909) * Updated CF saver version in User Guide and docstring (#3925) * Updated CF saver version in User Guide and docstring * Remove references to CF version of the loader in docstrings * Added whatsnew * Pin cftime<1.3.0 * Migrate to cirrus-ci (#3928) * migrate from travis-ci to cirrus-ci * added whatsnew entries * ignore url for doc link check (#3929) * whatsnew for coord default units (#3924) * Cube._summary_coord_extra: efficiency and bugfix (#3922) * Add Documentation Title Case Capitalization (#3940) * Use Title Case Capitalisation for Documentation * add whatsnew enter * CI requirements drop pip packages (#3939) * requirements pip to conda * use pip install over develop * default PY_VER to python versions * update links (#3942) * update links * added s to http * Add support for 1-d weights in collapse. (#3943) * Remove warning for convert_units on lazy data (#3951) * drop stickler references in docs (#3953) * drop stickler references in docs * remove sticker from common links * update docs for travis-ci to cirrus-ci (#3954) * update docs for travis-ci to cirrus-ci * add 'travis-ci' reference locally to whatsnew * update whatsnew comment * docs for nox (#3955) * docs for nox * add titles, notices and additional detail * review actions * Resolve test coverage (#3947) * test coverage for __init__ and __call__ * test coverage for metadata resolve and coverage * partial test coverage for metadata mapping * python 3.6 workaround for deepcopy of mock.sentinel * test coverage for Resolve._free_mapping * test coverage for Resolve convenience methods * add test stub for Resolve._metadata_mapping * fix Test__tgt_cube_position * test coverage for shape * test coverage for _as_compatible_cubes * test coverage for Resolve._metadata_mapping * test coverage for Resolve._prepare_common_dim_payload * test coverage for Resolve._prepare_common_aux_payload * test coverage for Resolve._prepare_points_and_bounds * test coverage for Resolve._create_prepared_item * test coverage for Resolve._prepare_local_payload_dim * test coverage for Resolve._prepare_local_payload_aux * test coverage for Resolve._prepare_local_payload_scalar + docs URL skip * test coverage for Resolve._prepare_local_payload * test coverage for Resolve._metadata_prepare * added docs URL linkcheck skip * test coverage for Resolve._prepare_factory_payload * test coverage for Resolve._get_prepared_item * review actions * test coverage for Resolve.cube * pin v3.0.0 version and whatnew date (#3956) * update github ci checks image (#3957) Co-authored-by: tkknight <[email protected]> Co-authored-by: Zeb Nicholls <[email protected]> Co-authored-by: Martin Yeo <[email protected]> Co-authored-by: Jon Seddon <[email protected]> Co-authored-by: Ruth Comer <[email protected]> Co-authored-by: Patrick Peglar <[email protected]>
SciTools · Jan 27, 2021 · 02777db · 02777db
1 parent e7eced5
commit 02777db
Show file tree

Hide file tree

Showing 96 changed files with 6,030 additions and 451 deletions.
diff --git a/docs/iris/gallery_code/general/plot_SOI_filtering.py b/docs/iris/gallery_code/general/plot_SOI_filtering.py
@@ -1,5 +1,5 @@
 """
-Applying a filter to a time-series
+Applying a Filter to a Time-Series
 ==================================
 
 This example demonstrates low pass filtering a time-series by applying a

diff --git a/docs/iris/gallery_code/general/plot_anomaly_log_colouring.py b/docs/iris/gallery_code/general/plot_anomaly_log_colouring.py
@@ -1,5 +1,5 @@
 """
-Colouring anomaly data with logarithmic scaling
+Colouring Anomaly Data With Logarithmic Scaling
 ===============================================
 
 In this example, we need to plot anomaly data where the values have a

diff --git a/docs/iris/gallery_code/general/plot_coriolis.py b/docs/iris/gallery_code/general/plot_coriolis.py
@@ -1,5 +1,5 @@
 """
-Deriving the Coriolis frequency over the globe
+Deriving the Coriolis Frequency Over the Globe
 ==============================================
 
 This code computes the Coriolis frequency and stores it in a cube with

diff --git a/docs/iris/gallery_code/general/plot_cross_section.py b/docs/iris/gallery_code/general/plot_cross_section.py
@@ -1,5 +1,5 @@
 """
-Cross section plots
+Cross Section Plots
 ===================
 
 This example demonstrates contour plots of a cross-sectioned multi-dimensional

diff --git a/docs/iris/gallery_code/general/plot_custom_aggregation.py b/docs/iris/gallery_code/general/plot_custom_aggregation.py
@@ -1,5 +1,5 @@
 """
-Calculating a custom statistic
+Calculating a Custom Statistic
 ==============================
 
 This example shows how to define and use a custom

diff --git a/docs/iris/gallery_code/general/plot_custom_file_loading.py b/docs/iris/gallery_code/general/plot_custom_file_loading.py
@@ -1,5 +1,5 @@
 """
-Loading a cube from a custom file format
+Loading a Cube From a Custom File Format
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 This example shows how a custom text file can be loaded using the standard Iris

diff --git a/docs/iris/gallery_code/general/plot_global_map.py b/docs/iris/gallery_code/general/plot_global_map.py
@@ -1,5 +1,5 @@
 """
-Quickplot of a 2d cube on a map
+Quickplot of a 2D Cube on a Map
 ===============================
 
 This example demonstrates a contour plot of global air temperature. The plot

diff --git a/docs/iris/gallery_code/general/plot_lineplot_with_legend.py b/docs/iris/gallery_code/general/plot_lineplot_with_legend.py
@@ -1,5 +1,5 @@
 """
-Multi-line temperature profile plot
+Multi-Line Temperature Profile Plot
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 """

diff --git a/docs/iris/gallery_code/general/plot_polar_stereo.py b/docs/iris/gallery_code/general/plot_polar_stereo.py
@@ -1,5 +1,5 @@
 """
-Example of a polar stereographic plot
+Example of a Polar Stereographic Plot
 =====================================
 
 Demonstrates plotting data that are defined on a polar stereographic

diff --git a/docs/iris/gallery_code/general/plot_polynomial_fit.py b/docs/iris/gallery_code/general/plot_polynomial_fit.py
@@ -1,5 +1,5 @@
 """
-Fitting a polynomial
+Fitting a Polynomial
 ====================
 
 This example demonstrates computing a polynomial fit to 1D data from an Iris

diff --git a/docs/iris/gallery_code/general/plot_projections_and_annotations.py b/docs/iris/gallery_code/general/plot_projections_and_annotations.py
@@ -1,5 +1,5 @@
 """
-Plotting in different projections
+Plotting in Different Projections
 =================================
 
 This example shows how to overlay data and graphics in different projections,

diff --git a/docs/iris/gallery_code/general/plot_rotated_pole_mapping.py b/docs/iris/gallery_code/general/plot_rotated_pole_mapping.py
@@ -1,5 +1,5 @@
 """
-Rotated pole mapping
+Rotated Pole Mapping
 =====================
 
 This example uses several visualisation methods to achieve an array of

diff --git a/docs/iris/gallery_code/meteorology/plot_COP_1d.py b/docs/iris/gallery_code/meteorology/plot_COP_1d.py
@@ -1,5 +1,5 @@
 """
-Global average annual temperature plot
+Global Average Annual Temperature Plot
 ======================================
 
 Produces a time-series plot of North American temperature forecasts for 2

diff --git a/docs/iris/gallery_code/meteorology/plot_COP_maps.py b/docs/iris/gallery_code/meteorology/plot_COP_maps.py
@@ -1,5 +1,5 @@
 """
-Global average annual temperature maps
+Global Average Annual Temperature Maps
 ======================================
 
 Produces maps of global temperature forecasts from the A1B and E1 scenarios.

diff --git a/docs/iris/gallery_code/meteorology/plot_TEC.py b/docs/iris/gallery_code/meteorology/plot_TEC.py
@@ -1,5 +1,5 @@
 """
-Ionosphere space weather
+Ionosphere Space Weather
 ========================
 
 This space weather example plots a filled contour of rotated pole point

diff --git a/docs/iris/gallery_code/meteorology/plot_hovmoller.py b/docs/iris/gallery_code/meteorology/plot_hovmoller.py
@@ -1,5 +1,5 @@
 """
-Hovmoller diagram of monthly surface temperature
+Hovmoller Diagram of Monthly Surface Temperature
 ================================================
 
 This example demonstrates the creation of a Hovmoller diagram with fine control

diff --git a/docs/iris/gallery_code/meteorology/plot_lagged_ensemble.py b/docs/iris/gallery_code/meteorology/plot_lagged_ensemble.py
@@ -1,5 +1,5 @@
 """
-Seasonal ensemble model plots
+Seasonal Ensemble Model Plots
 =============================
 
 This example demonstrates the loading of a lagged ensemble dataset from the

diff --git a/docs/iris/gallery_code/meteorology/plot_wind_speed.py b/docs/iris/gallery_code/meteorology/plot_wind_speed.py
@@ -1,6 +1,6 @@
 """
-Plotting wind direction using quiver
-===========================================================
+Plotting Wind Direction Using Quiver
+====================================
 
 This example demonstrates using quiver to plot wind speed contours and wind
 direction arrows from wind vector component input data. The vector components

diff --git a/docs/iris/gallery_code/oceanography/plot_atlantic_profiles.py b/docs/iris/gallery_code/oceanography/plot_atlantic_profiles.py
@@ -1,5 +1,5 @@
 """
-Oceanographic profiles and T-S diagrams
+Oceanographic Profiles and T-S Diagrams
 =======================================
 
 This example demonstrates how to plot vertical profiles of different

diff --git a/docs/iris/gallery_code/oceanography/plot_load_nemo.py b/docs/iris/gallery_code/oceanography/plot_load_nemo.py
@@ -1,5 +1,5 @@
 """
-Load a time series of data from the NEMO model
+Load a Time Series of Data From the NEMO Model
 ==============================================
 
 This example demonstrates how to load multiple files containing data output by

diff --git a/docs/iris/src/common_links.inc b/docs/iris/src/common_links.inc
@@ -12,9 +12,8 @@
 .. _iris-sample-data: https://github.com/SciTools/iris-sample-data
 .. _test-iris-imagehash: https://github.com/SciTools/test-iris-imagehash
 .. _readthedocs.yml: https://github.com/SciTools/iris/blob/master/requirements/ci/readthedocs.yml
-.. _travis-ci: https://travis-ci.org/github/SciTools/iris
-.. _.travis.yml: https://github.com/SciTools/iris/blob/master/.travis.yml
-.. _.stickler.yml: https://github.com/SciTools/iris/blob/master/.stickler.yml
+.. _cirrus-ci: https://cirrus-ci.com/github/SciTools/iris
+.. _.cirrus.yml: https://github.com/SciTools/iris/blob/master/.cirrus.yml
 .. _.flake8.yml: https://github.com/SciTools/iris/blob/master/.flake8
 .. _GitHub Help Documentation: https://docs.github.com/en/github
 .. _using git: https://docs.github.com/en/github/using-git

diff --git a/docs/iris/src/conf.py b/docs/iris/src/conf.py
@@ -230,7 +230,7 @@ def autolog(message):
     "menu_links_name": "Support",
     "menu_links": [
         (
-            '<i class="fa fa-github fa-fw"></i> Source code',
+            '<i class="fa fa-github fa-fw"></i> Source Code',
             "https://github.com/SciTools/iris",
         ),
         (
@@ -242,11 +242,11 @@ def autolog(message):
             "https://groups.google.com/forum/#!forum/scitools-iris-dev",
         ),
         (
-            '<i class="fa fa-question fa-fw"></i> StackOverflow for "How do I?"',
+            '<i class="fa fa-question fa-fw"></i> StackOverflow for "How Do I?"',
             "https://stackoverflow.com/questions/tagged/python-iris",
         ),
         (
-            '<i class="fa fa-book fa-fw"></i> Legacy documentation',
+            '<i class="fa fa-book fa-fw"></i> Legacy Documentation',
             "https://scitools.org.uk/iris/docs/v2.4.0/index.html",
         ),
     ],
@@ -269,6 +269,8 @@ def autolog(message):
     "http://schacon.github.com/git",
     "http://scitools.github.com/cartopy",
     "http://www.wmo.int/pages/prog/www/DPFS/documents/485_Vol_I_en_colour.pdf",
+    "https://software.ac.uk/how-cite-software",
+    "http://www.esrl.noaa.gov/psd/data/gridded/conventions/cdc_netcdf_standard.shtml",
 ]
 
 # list of sources to exclude from the build.

diff --git a/docs/iris/src/copyright.rst b/docs/iris/src/copyright.rst
@@ -1,8 +1,8 @@
 
-Iris copyright, licensing and contributors
+Iris Copyright, Licensing and Contributors
 ==========================================
 
-Iris code
+Iris Code
 ---------
 
 All Iris source code, unless explicitly stated, is ``Copyright Iris
@@ -20,7 +20,7 @@ You should find all source files with the following header:
     licensing details.
 
 
-Iris documentation and examples
+Iris Documentation and Examples
 -------------------------------
 
 All documentation, examples and sample data found on this website and in source repository 

diff --git a/docs/iris/src/developers_guide/ci_checks.png b/docs/iris/src/developers_guide/ci_checks.png
diff --git a/docs/iris/src/developers_guide/contributing_changes.rst b/docs/iris/src/developers_guide/contributing_changes.rst
@@ -1,7 +1,7 @@
 
 .. _contributing.changes:
 
-Contributing your changes
+Contributing Your Changes
 =========================
 
 .. toctree::

diff --git a/docs/iris/src/developers_guide/contributing_ci_tests.rst b/docs/iris/src/developers_guide/contributing_ci_tests.rst
@@ -10,8 +10,7 @@ automatically when a pull request is created, updated or merged against
 Iris **master**.  The checks performed are:
 
 * :ref:`testing_cla`
-* :ref:`testing_travis`
-* :ref:`testing_stickler`
+* :ref:`testing_cirrus`
 
 
 .. _testing_cla:
@@ -24,33 +23,23 @@ A bot that checks the user who created the pull request has signed the
 please see https://scitools.org.uk/organisation.html#governance
 
 
-.. _testing_stickler:
+.. _testing_cirrus:
 
-Stickler CI
-***********
-
-Automatically enforces coding standards.  The configuration file named
-`.stickler.yml`_ is in the Iris_ root directory.  For more information see
-https://stickler-ci.com/.
-
-
-.. _testing_travis:
-
-Travis-CI
+Cirrus-CI
 *********
 
 The unit and integration tests in Iris are an essential mechanism to ensure
 that the Iris code base is working as expected.  :ref:`developer_running_tests`
 may be run manually but to ensure the checks are performed a
-continuous integration testing tool named `travis-ci`_ is used.
+continuous integration testing tool named `cirrus-ci`_ is used.
 
-A `travis-ci`_ configuration file named `.travis.yml`_
-is in the Iris repository which tells travis-ci what commands to run.  The
+A `cirrus-ci`_ configuration file named `.cirrus.yml`_
+is in the Iris repository which tells Cirrus-CI what commands to run.  The
 commands include retrieving the Iris code base and associated test files using
-conda and then running the tests.  `travis-ci`_ allows for a matrix of tests to
+conda and then running the tests.  `cirrus-ci`_ allows for a matrix of tests to
 be performed to ensure that all expected variations test successfully.
 
-The `travis-ci`_ tests are run automatically against the `Iris`_ master
+The `cirrus-ci`_ tests are run automatically against the `Iris`_ master
 repository when a pull request is submitted, updated or merged.
 
 GitHub Checklist

diff --git a/docs/iris/src/developers_guide/contributing_code_formatting.rst b/docs/iris/src/developers_guide/contributing_code_formatting.rst
@@ -2,7 +2,7 @@
 
 .. _code_formatting:
 
-Code formatting
+Code Formatting
 ===============
 
 To ensure a consistent code format throughout Iris, we recommend using

diff --git a/docs/iris/src/developers_guide/contributing_codebase_index.rst b/docs/iris/src/developers_guide/contributing_codebase_index.rst
@@ -1,6 +1,6 @@
 .. _contributing.documentation.codebase:
 
-Contributing to the code base
+Contributing to the Code Base
 =============================
 
 .. toctree::

diff --git a/docs/iris/src/developers_guide/contributing_deprecations.rst b/docs/iris/src/developers_guide/contributing_deprecations.rst
@@ -10,12 +10,12 @@ one release, before removing/updating it in the next
 `major release <http://semver.org/>`_.
 
 
-Adding a deprecation
+Adding a Deprecation
 ====================
 
 .. _removing-a-public-api:
 
-Removing a public API
+Removing a Public API
 ---------------------
 
 The simplest form of deprecation occurs when you need to remove a public
@@ -49,7 +49,7 @@ Under these circumstances the following points apply:
  - You should check the documentation for references to the deprecated
    API and update them as appropriate.
 
-Changing a default
+Changing a Default
 ------------------
 
 When you need to change the default behaviour of a public API the
@@ -74,7 +74,7 @@ API:
    deprecation warning and corresponding Sphinx deprecation directive.
 
 
-Removing a deprecation
+Removing a Deprecation
 ======================
 
 When the time comes to make a new major release you should locate any
@@ -83,15 +83,15 @@ minimum period described previously. Locating deprecated APIs can easily
 be done by searching for the Sphinx deprecation directives and/or
 deprecation warnings.
 
-Removing a public API
+Removing a Public API
 ---------------------
 
 The deprecated API should be removed and any corresponding documentation
 and/or example code should be removed/updated as appropriate.
 
 .. _iris_developer_future:
 
-Changing a default
+Changing a Default
 ------------------
 
  - You should update the initial state of the relevant boolean attribute

diff --git a/docs/iris/src/developers_guide/contributing_documentation.rst b/docs/iris/src/developers_guide/contributing_documentation.rst
@@ -1,7 +1,7 @@
 
 .. _contributing.documentation:
 
-Contributing to the documentation
+Contributing to the Documentation
 ---------------------------------
 
 Documentation is important and we encourage any improvements that can be made.
@@ -28,7 +28,7 @@ The build can be run from the documentation directory ``iris/docs/iris/src``.
 
 The build output for the html is found in the ``_build/html`` sub directory.
 When updating the documentation ensure the html build has *no errors* or
-*warnings* otherwise it may fail the automated `travis-ci`_  build.
+*warnings* otherwise it may fail the automated `cirrus-ci`_  build.
 
 Once the build is complete, if it is rerun it will only rebuild the impacted
 build artefacts so should take less time.
@@ -50,7 +50,7 @@ This is useful for a final test before committing your changes.
           have been promoted to be **errors** to ensure they are addressed.
           This **only** applies when ``make html`` is run.
 
-.. _travis-ci: https://travis-ci.org/github/SciTools/iris
+.. _cirrus-ci: https://cirrus-ci.com/github/SciTools/iris
 
 .. _contributing.documentation.testing:
 
@@ -99,7 +99,7 @@ or ignore the url.
     ``spelling_word_list_filename``.
 
 
-.. note:: In addition to the automated `travis-ci`_ build of all the
+.. note:: In addition to the automated `cirrus-ci`_ build of all the
           documentation build options above, the
           https://readthedocs.org/ service is also used.  The configuration
           of this held in a file in the root of the
@@ -112,7 +112,7 @@ or ignore the url.
 
 .. _contributing.documentation.api:
 
-Generating API documentation
+Generating API Documentation
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 In order to auto generate the API documentation based upon the docstrings a

diff --git a/docs/iris/src/developers_guide/contributing_getting_involved.rst b/docs/iris/src/developers_guide/contributing_getting_involved.rst
@@ -2,7 +2,7 @@
 
 .. _development_where_to_start:
 
-Getting involved
+Getting Involved
 ----------------
 
 Iris_ is an Open Source project hosted on Github and as such anyone with a