szkGraph 0.0.3

An easy graph formatting tool for matplotlib

szkGraph - simple style formatter for matplotlib

This is a useful Python codes to simply modify the style of matplotlib for your presentation and academic papers. Any type of suggestions, feedbacks, and upgrades are welcome.

How to install?

Install using pip.

python -m pip install -U szkGraph

Then, import as follows.

import szkGraph.formatter

How to use?

Call formatter.prepare() to initialize the figure. Use the returned fig, ax for plotting. After plotting and modifying your figure, export the figure with formatter.finalize().

formatter.prepare(xtitle=None, ytitle=None, w=None, h=None, r=0.7, font="arial", fontsize=20)

Paramters

• xtitle: str, optional Title of x-axis.
• ytitle: str, optional Title of y-axis.
• w: float or str, optional Float for specifying the width in inches, str for specifying the width relative to powerpoint slide or academic paper. Use pp1/X for one-X-th of powerpoint slide (16:9), ppX for X times of powerpoint slide (16:9), and 1col etc. for figures in academic paper.
• h: float, optional Height in inches.
• r: float, optional Ratio of height to width.
• font: str, optional Fontname. It should be either arial or times.
• fontsize: int, optional Fontsize in pt.

Returns

• fig: matplotlib.figure
• ax: matplotlib.axes

formatter.finalize(fig, ax, fn_figout, lims=[None, None, None, None], dpi=300, comp={}, tight=True, pad=0.2, xspace=None, yspace=None)

Paramters

• fig: matplotlib.figure
• ax: matplotlib.axes
• fn_figout: str Name of the output figure file. It could also be in absolute or relative path.
• lims: list of floats, optional Range of axis in one list as [xmin, xmax, ymin, ymax].
• dpi: int, optional Value of dpi.
• pil_kwargs: dict, optional Dictionary that will be directly passed to PIL.Image.Image.save.
• tight: bool, optional Whether to use matplotlib.pyplot.tight_layout().
• pad: float, optional Padding for matplotlib.pyplot.tight_layout().
• xspace: float or tuple of floats Float for specifying x-tick spacing, tuple of floats for specyfing (x-tick spacing, offset). See matplotlib.ticker.MultipleLocator().
• yspace: float or tuple of floats Float for specifying y-tick spacing, tuple of floats for specyfing (y-tick spacing, offset). See matplotlib.ticker.MultipleLocator().

Returns

• fig: matplotlib.figure
• ax: matplotlib.axes

License

szkGraph is available under MIT license. See the LICENSE file for more info.