1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
.. title:: pytest-mpl documentation
.. module:: pytest-mpl
.. toctree::
:hidden:
installing
usage
image_mode
hash_mode
hybrid_mode
configuration
##################################
pytest-mpl |release| documentation
##################################
``pytest-mpl`` is a `pytest <https://docs.pytest.org>`__ plugin to facilitate image comparison for `Matplotlib <http://www.matplotlib.org>`__ figures.
For each figure to test, an image is generated and then subtracted from an existing reference image.
If the RMS of the residual is larger than a user-specified tolerance, the test will fail.
Alternatively, the generated image can be hashed and compared to an expected value.
************
Installation
************
.. grid:: 1 1 2 2
.. grid-item::
Install using `pip <https://pypi.org/project/pytest-mpl>`__:
.. code-block:: bash
pip install pytest-mpl
.. grid-item::
Install from `conda-forge <https://github.com/conda-forge/pytest-mpl-feedstock#installing-pytest-mpl>`__ using `conda <https://docs.continuum.io/anaconda/>`__:
.. code-block:: bash
conda install pytest-mpl
Further details are available in the :doc:`Installation Guide <installing>`.
******************
Learning resources
******************
.. grid:: 1 1 2 2
.. grid-item-card::
:padding: 2
Tutorials
^^^
- :doc:`Get started <usage>`
.. grid-item-card::
:padding: 2
How-tos
^^^
- :doc:`Image comparison mode <image_mode>`
- :doc:`Hash comparison mode <hash_mode>`
- :doc:`Hybrid mode <hybrid_mode>`
.. grid-item-card::
:padding: 2
Understand how pytest-mpl works
^^^
Explanatory information is included where relevant throughout the documentation.
.. grid-item-card::
:padding: 2
Reference
^^^
- :doc:`Configuration <configuration>`
************
Contributing
************
``pytest-mpl`` is a community project maintained for and by its users.
There are many ways you can help!
- Report a bug or request a feature `on GitHub <https://github.com/matplotlib/pytest-mpl/issues>`__
- Improve the documentation or code
|
