diff --git a/README.md b/README.md index 5a4a4e0..a7bad77 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,13 @@ other libraries building on matplotlib like [pandas][pd] or [seaborn][sns]. The plotting style is set to aproximately the styles described in [our wiki][wiki], more precicely in this [PowerPoint presentation][ppt]. +### Before: + +![Default matplotlib style](example_before.png) + +### After: + +![CPI matplotlib style](example_after.png) ## how to use it @@ -39,7 +46,9 @@ To use this style as your default matplotlib style, have a look at the 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 +## the examples + +If you are curios on how the examples were created, have a look at the [Jupyter Notebook][jupyter] `example.ipynb`. [mpl]: https://matplotlib.org/ @@ -47,4 +56,5 @@ Please add changes only to the file `custom cpi style.txt`. After modifying the [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 -[default]: https://matplotlib.org/stable/tutorials/introductory/customizing.html#customizing-with-matplotlibrc-files \ No newline at end of file +[default]: https://matplotlib.org/stable/tutorials/introductory/customizing.html#customizing-with-matplotlibrc-files +[jupyter]: https://jupyter.org/ \ No newline at end of file diff --git a/example_after.png b/example_after.png new file mode 100644 index 0000000..3118af2 Binary files /dev/null and b/example_after.png differ diff --git a/example_before.png b/example_before.png new file mode 100644 index 0000000..3e91935 Binary files /dev/null and b/example_before.png differ