Module `open_atmos_jupyter_utils.show_plot`

Expand source code

# pylint: disable=missing-module-docstring

from matplotlib import pyplot
from IPython.display import display
from IPython.core.interactiveshell import InteractiveShell
from IPython.core.pylabtools import select_figure_formats
from open_atmos_jupyter_utils.temporary_file import TemporaryFile


def show_plot(filename=None, fig=pyplot, inline_format='svg'):
    """ the missing click-to-save-as-pdf button for matplotlib/Jupyter (use instead of *.show()) """
    link = save_and_make_link(fig, filename)
    select_figure_formats(InteractiveShell.instance(), {inline_format})
    pyplot.show()
    display(link)


def save_and_make_link(fig, filename=None):
    """ saves a figure as pdf and returns a Jupyter display()-able click-to-download widget """
    temporary_file = TemporaryFile(suffix='.pdf', filename=filename)
    fig.savefig(temporary_file.absolute_path, bbox_inches='tight')
    return temporary_file.make_link_widget()

Functions

def save_and_make_link(fig, filename=None)

saves a figure as pdf and returns a Jupyter display()-able click-to-download widget

Expand source code

def save_and_make_link(fig, filename=None):
    """ saves a figure as pdf and returns a Jupyter display()-able click-to-download widget """
    temporary_file = TemporaryFile(suffix='.pdf', filename=filename)
    fig.savefig(temporary_file.absolute_path, bbox_inches='tight')
    return temporary_file.make_link_widget()

def show_plot(filename=None, fig=<module 'matplotlib.pyplot' from '/opt/hostedtoolcache/Python/3.11.9/x64/lib/python3.11/site-packages/matplotlib/pyplot.py'>, inline_format='svg')

the missing click-to-save-as-pdf button for matplotlib/Jupyter (use instead of *.show())

Expand source code

def show_plot(filename=None, fig=pyplot, inline_format='svg'):
    """ the missing click-to-save-as-pdf button for matplotlib/Jupyter (use instead of *.show()) """
    link = save_and_make_link(fig, filename)
    select_figure_formats(InteractiveShell.instance(), {inline_format})
    pyplot.show()
    display(link)