From 68bd8103b847bebf1f5afa69f75f50d37a2fdcd0 Mon Sep 17 00:00:00 2001 From: Holger Frey Date: Wed, 5 May 2021 15:57:26 +0200 Subject: [PATCH] working on readme --- README.md | 46 ++++++++++++++++++++++++++++++---------------- 1 file changed, 30 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 926893b..5a4a4e0 100644 --- a/README.md +++ b/README.md @@ -4,33 +4,47 @@ This library provides a custom plotting style for [matplotlib][mpl] and other libraries building on matplotlib like [pandas][pd] or [seaborn][sns]. The plotting style is set to aproximately the styles described in -[our wiki], more precicely in this [PowerPoint presentation][ppt]. +[our wiki][wiki], more precicely in this [PowerPoint presentation][ppt]. ## how to use it -copy the file `cpi.mplstyle` into the directory with your analysis and tell +Copy the file `cpi.mplstyle` into the directory with your analysis and tell matplotlib to use this style: -usage with matplotlib / pyplot: -> from matplotlib import pyplot -> pyplot.style.use('./cpi.mplstyle') -usage with other libraries based on matplotlib, like searborn: -> from matplotlib import pyplot -> import seaborn -> pyplot.style.use('./cpi.mplstyle') +```python +from matplotlib import pyplot +pyplot.style.use('./cpi.mplstyle') +``` -be aware that the set* functions of seaborn (like set_theme) might -mess with the matplotlib style. +For usage with other graphing libraries like searborn: -to use the seaborn.set_palette() function to change line colors seems -to be fine -to use this style as your default matplotlib style, have a look at -https://matplotlib.org/stable/tutorials/introductory/customizing.html#customizing-with-matplotlibrc-files +```python +from matplotlib import pyplot +import seaborn +pyplot.style.use('./cpi.mplstyle') +``` + +Be aware that the `set*` functions of seaborn (like set_theme) might mess with the +matplotlib style. The `seaborn.set_palette()` function to change line colors seems to be woring fine + + +## set as default style + +To use this style as your default matplotlib style, have a look at the +[matplotlib documentation][default], I haven't tried it out so far. + + +## how to make changes + +Please add changes only to the file `custom cpi style.txt`. After modifying the file use `python3 compile.py` to generate a file with custom styles. + +## example [mpl]: https://matplotlib.org/ [pd]: https://pandas.pydata.org/ [sns]: https://seaborn.pydata.org/ [wiki]: https://wiki.cpi.imtek.uni-freiburg.de/ScientificWriting -[ppt]: https://wiki.cpi.imtek.uni-freiburg.de/ScientificWriting?action=AttachFile&do=view&target=140109-scientific-writing-06-figures-and-figure-captions.pptx \ No newline at end of file +[ppt]: https://wiki.cpi.imtek.uni-freiburg.de/ScientificWriting?action=AttachFile&do=view&target=140109-scientific-writing-06-figures-and-figure-captions.pptx +[default]: https://matplotlib.org/stable/tutorials/introductory/customizing.html#customizing-with-matplotlibrc-files \ No newline at end of file