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

1import matplotlib as mpl 

2import matplotlib.pyplot as plt 

3import shutil 

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 'Springer_proceedings': 347.12354, 

46 'JSC_thesis': 434.26027, 

47 'TUHH_thesis': 426.79135, 

48 'Nature_CS': 372.0, 

49 } 

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

51 textheights = { 

52 'JSC_beamer': 214.43411, 

53 'JSC_thesis': 635.5, 

54 'TUHH_thesis': 631.65118, 

55 'Springer_proceedings': 549.13828, 

56 'Nature_CS': 552.69478, 

57 } 

58 assert ( 

59 journal in textwidths.keys() 

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

61 

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

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

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

65 raise ValueError( 

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

67 ) 

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

69 

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

71 

72 

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

74 if reset: 

75 mpl.rcParams.update(default_mpl_params) 

76 

77 # Set up plotting parameters 

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

79 "font.family": "serif", 

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

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

82 "font.monospace": [], 

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

84 "axes.linewidth": 0.5, 

85 "font.size": font_size, 

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

87 "legend.numpoints": 1, 

88 # "xtick.labelsize": 6, 

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

90 "xtick.minor.width": 0.25, 

91 # "ytick.labelsize": 6, 

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

93 "ytick.minor.width": 0.25, 

94 "lines.markersize": 4, 

95 "lines.markeredgewidth": 0.5, 

96 "grid.linewidth": 0.5, 

97 "grid.linestyle": '-', 

98 "grid.alpha": 0.25, 

99 "figure.subplot.hspace": 0.0, 

100 "savefig.pad_inches": 0.01, 

101 } 

102 

103 mpl.rcParams.update(style_options) 

104 

105 if shutil.which('latex'): 

106 latex_support = { 

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

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

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

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

111 r"\usepackage{underscore}" 

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

113 } 

114 else: 

115 latex_support = { 

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

117 } 

118 

119 mpl.rcParams.update(latex_support) 

120 plt.close('all') 

121 

122 

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

124 plt.clf() 

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

126 return fig, ax 

127 

128 

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

130 if save_pgf and shutil.which('latex'): 

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

132 if save_pdf: 

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

134 if save_png: 

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

136 plt.close()