Coverage for pySDC/helpers/plot_helper.py: 94%

1import matplotlib as mpl 

2import matplotlib.pyplot as plt 

3from distutils.spawn import find_executable 

4 

5default_mpl_params = mpl.rcParams.copy() 

6 

7 

8def figsize(textwidth, scale, ratio): 

9 """ 

10 Get figsize. 

11 

12 Args: 

13 textwidth (str): Textwdith in your LaTeX file in points 

14 scale (float): The width of the figure relative to the textwidth 

15 ratio (float): The height of the figure relative to its width 

16 

17 Returns: 

18 list: Width and height of the figure to be passed to matplotlib 

19 """ 

20 fig_width_pt = textwidth # Get this from LaTeX using \the\textwidth 

21 inches_per_pt = 1.0 / 72.27 # Convert pt to inch 

22 fig_width = fig_width_pt * inches_per_pt * scale # width in inches 

23 fig_height = fig_width * ratio # height in inches 

24 fig_size = [fig_width, fig_height] 

25 return fig_size 

26 

27 

28def figsize_by_journal(journal, scale, ratio): # pragma: no cover 

29 """ 

30 Get figsize for specific journal. If you supply a text height, we will rescale the figure to fit on the page instead 

31 of the parameters supplied. 

32 

33 Args: 

34 journal (str): Name of journal 

35 scale (float): The width of the figure relative to the textwidth 

36 ratio (float): The height of the figure relative to its width 

37 

38 Returns: 

39 list: Width and height of the figure to be passed to matplotlib 

40 """ 

41 # store text width in points here, get this from LaTeX using \the\textwidth 

42 textwidths = { 

43 'JSC_beamer': 426.79135, 

44 'Springer_Numerical_Algorithms': 338.58778, 

45 'JSC_thesis': 434.26027, 

46 } 

47 # store text height in points here, get this from LaTeX using \the\textheight 

48 textheights = { 

49 'JSC_beamer': 214.43411, 

50 'JSC_thesis': 635.5, 

51 } 

52 assert ( 

53 journal in textwidths.keys() 

54 ), f"Textwidth only available for {list(textwidths.keys())}. Please implement one for \"{journal}\"! Get the textwidth using \"\\the\\textwidth\" in your tex file." 

55 

56 # see if the figure fits on the page or if we need to apply the scaling to the height instead 

57 if scale * ratio * textwidths[journal] > textheights.get(journal, 1e9): 

58 if textheights[journal] / scale / ratio > textwidths[journal]: 

59 raise ValueError( 

60 f"We cannot fit figure with scale {scale:.2f} and ratio {ratio:.2f} on the page for journal {journal}!" 

61 ) 

62 return figsize(textheights[journal] / (scale * ratio), 1, ratio) 

63 

64 return figsize(textwidths[journal], scale, ratio) 

65 

66 

67def setup_mpl(font_size=8, reset=False): 

68 if reset: 

69 mpl.rcParams.update(default_mpl_params) 

70 

71 # Set up plotting parameters 

72 style_options = { # setup matplotlib to use latex for output 

73 "font.family": "serif", 

74 "font.serif": [], # blank entries should cause plots to inherit fonts from the document 

75 "font.sans-serif": [], 

76 "font.monospace": [], 

77 # "axes.labelsize": 8, # LaTeX default is 10pt font. 

78 "axes.linewidth": 0.5, 

79 "font.size": font_size, 

80 # "legend.fontsize": 6, # Make the legend/label fonts a little smaller 

81 "legend.numpoints": 1, 

82 # "xtick.labelsize": 6, 

83 "xtick.major.width": 0.5, # major tick width in points 

84 "xtick.minor.width": 0.25, 

85 # "ytick.labelsize": 6, 

86 "ytick.major.width": 0.5, # major tick width in points 

87 "ytick.minor.width": 0.25, 

88 "lines.markersize": 4, 

89 "lines.markeredgewidth": 0.5, 

90 "grid.linewidth": 0.5, 

91 "grid.linestyle": '-', 

92 "grid.alpha": 0.25, 

93 "figure.subplot.hspace": 0.0, 

94 "savefig.pad_inches": 0.01, 

95 } 

96 

97 mpl.rcParams.update(style_options) 

98 

99 if find_executable('latex'): 

100 latex_support = { 

101 "pgf.texsystem": "pdflatex", # change this if using xetex or lautex 

102 "text.usetex": True, # use LaTeX to write all text 

103 "pgf.preamble": r"\usepackage[utf8x]{inputenc}" 

104 r"\usepackage[T1]{fontenc}" 

105 r"\usepackage{underscore}" 

106 r"\usepackage{amsmath,amssymb,marvosym}", 

107 } 

108 else: 

109 latex_support = { 

110 "text.usetex": False, # use LaTeX to write all text 

111 } 

112 

113 mpl.rcParams.update(latex_support) 

114 plt.close('all') 

115 

116 

117def newfig(textwidth, scale, ratio=0.6180339887): 

118 plt.clf() 

119 fig, ax = plt.subplots(figsize=figsize(textwidth, scale, ratio)) 

120 return fig, ax 

121 

122 

123def savefig(filename, save_pdf=True, save_pgf=True, save_png=True): 

124 if save_pgf and find_executable('latex'): 

125 plt.savefig('{}.pgf'.format(filename), bbox_inches='tight') 

126 if save_pdf: 

127 plt.savefig('{}.pdf'.format(filename), bbox_inches='tight') 

128 if save_png: 

129 plt.savefig('{}.png'.format(filename), bbox_inches='tight') 

130 plt.close()