diff --git a/docs/iris/src/developers_guide/documenting/whats_new_contributions.rst b/docs/iris/src/developers_guide/documenting/whats_new_contributions.rst index 6b039d0ae9..203a422457 100644 --- a/docs/iris/src/developers_guide/documenting/whats_new_contributions.rst +++ b/docs/iris/src/developers_guide/documenting/whats_new_contributions.rst @@ -1,3 +1,5 @@ +.. _whats_new_contributions: + ================================= Contributing a "What's New" entry ================================= diff --git a/docs/iris/src/developers_guide/graphics_tests.rst b/docs/iris/src/developers_guide/graphics_tests.rst new file mode 100644 index 0000000000..d4e4fa41c2 --- /dev/null +++ b/docs/iris/src/developers_guide/graphics_tests.rst @@ -0,0 +1,6 @@ +.. _developer_graphics_tests: + +Graphics tests +************** + +TODO: a full description is pending, will be provided for release 1.12. diff --git a/docs/iris/src/developers_guide/tests.rst b/docs/iris/src/developers_guide/tests.rst index 4ad9e0de0b..4d06fee61f 100644 --- a/docs/iris/src/developers_guide/tests.rst +++ b/docs/iris/src/developers_guide/tests.rst @@ -1,3 +1,5 @@ +.. _developer_tests: + Testing ******* @@ -125,3 +127,24 @@ developers locate relevant tests. It is recommended they are named according to the capabilities under test, e.g. `metadata/test_pp_preservation.py`, and not named according to the module(s) under test. + + +Graphics tests +================= +Certain Iris tests rely on testing plotted results. +This is required for testing the modules :mod:`iris.plot` and +:mod:`iris.quickplot`, but is also used for some other legacy and integration +tests. + +Prior to Iris version 1.10, a single reference image for each test was stored +in the main Iris repository, and a 'tolerant' test was performed against this. + +From version 1.11 onwards, graphics test outputs are compared against possibly +*multiple* known-good images, of which only a signature is stored. +This uses a sophisticated perceptual "image hashing" scheme (see: +). +Only imagehash signatures are stored in the Iris repo itself, thus freeing up +valuable space. Meanwhile, the actual reference *images*, which are required +for human-eyes evaluation of proposed new "good results", are all stored +elsewhere in a separate public repository. +See :ref:`developer_graphics_tests`.