From 9e6799024a1ddad1a9982be51eafb8bd3a792c26 Mon Sep 17 00:00:00 2001 From: Theomat Date: Sun, 6 Feb 2022 13:01:38 +0100 Subject: [PATCH] Improved README --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1a3e701..c0c5b75 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,10 @@ # pltpublish +This project on [PyPi](https://pypi.org/project/pltpublish/)|[GitHub](https://github.com/Theomat/pltpublish). + Utility package that takes care of configuring Matplotlib for publication-ready figures! + ## Easy to use **Before**                            **After** @@ -9,7 +12,7 @@ Utility package that takes care of configuring Matplotlib for publication-ready ```python > import pltpublish as pub > pub.setup() -# your plot code > # your plot code +# your plot code using plt > # your plot code using plt plt.savefig("my_fig.eps") > pub.save_fig("my_fig.eps") ``` @@ -22,6 +25,6 @@ plt.savefig("my_fig.eps") > pub.save_fig("my_fig.eps") - `setup` calls all `setup_*` methods - `setup_colorblind` configures matplotlib to use a colorblind palette - `setup_latex_fonts` configures matplotlib to use LaTeX fonts -- `save_fig` acts like `pyplot.save_fig` but guarantees a minimum dpi, that the grid is on and removes outer white space +- `save_fig` acts like `pyplot.savefig` but guarantees a minimum dpi, that the grid is on and removes outer white space - `extract_legend_as_figure` extracts the legend of your figure and plots it on another new figure - `layout_for_subplots` finds automatically a good layout given the number of plots you have to plot on the same figure