Skip to content

openscm_calibration.matplotlib_utils#

Matplotlib utility functions

Functions:

Name Description
get_fig_axes_holder_from_mosaic

Get figure, axes and holder from mosaic

get_fig_axes_holder_from_mosaic #

get_fig_axes_holder_from_mosaic(
    mosaic: list[list[str]], **kwargs: Any
) -> tuple[Figure, dict[str, Axes], DisplayHandle]

Get figure, axes and holder from mosaic

This is a convenience function

Parameters:

Name Type Description Default
mosaic list[list[str]]

Mosaic to use

 required
**kwargs Any

Passed to :func:matplotlib.pyplot.subplot_mosaic

 {}

Returns:

Type Description
Created figure, axes and holder

Raises:

Type Description
ImportError

matplotlib is not installed or IPython is not installed
Source code in src/openscm_calibration/matplotlib_utils.py 
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
def get_fig_axes_holder_from_mosaic(
    mosaic: list[list[str]],
    **kwargs: Any,
) -> tuple[
    matplotlib.figure.Figure,
    dict[str, matplotlib.axes.Axes],
    IPython.core.display_functions.DisplayHandle,
]:
    """
    Get figure, axes and holder from mosaic

    This is a convenience function

    Parameters
    ----------
    mosaic
        Mosaic to use

    **kwargs
        Passed to :func:`matplotlib.pyplot.subplot_mosaic`

    Returns
    -------
        Created figure, axes and holder

    Raises
    ------
    ImportError
        ``matplotlib`` is not installed or ``IPython`` is not installed
    """
    try:
        import matplotlib.pyplot as plt
    except ImportError as exc:
        raise MissingOptionalDependencyError(
            "get_fig_axes_holder_from_mosaic", requirement="matplotlib"
        ) from exc

    try:
        import IPython.display
    except ImportError as exc:
        raise MissingOptionalDependencyError(
            "get_fig_axes_holder_from_mosaic", requirement="IPython"
        ) from exc

    fig, axes = plt.subplot_mosaic(
        mosaic=mosaic,  # type: ignore # matplotlib's type hints are unclear
        **kwargs,
    )
    holder = IPython.display.display(fig, display_id=True)  # type: ignore

    return fig, axes, holder