Browse Source

added examples to readme

main
Holger Frey 4 years ago
parent
commit
fe49d1af39
  1. 14
      README.md
  2. BIN
      example_after.png
  3. BIN
      example_before.png

14
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 The plotting style is set to aproximately the styles described in
[our wiki][wiki], more precicely in this [PowerPoint presentation][ppt]. [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 ## 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. 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/ [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/ [sns]: https://seaborn.pydata.org/
[wiki]: https://wiki.cpi.imtek.uni-freiburg.de/ScientificWriting [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 [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 [default]: https://matplotlib.org/stable/tutorials/introductory/customizing.html#customizing-with-matplotlibrc-files
[jupyter]: https://jupyter.org/

BIN
example_after.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 229 KiB

BIN
example_before.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 62 KiB

Loading…
Cancel
Save