Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
killiansheriff committed Mar 5, 2024
1 parent 7368105 commit 62e2942
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
http://doi.org/10.5281/zenodo.6903937)

> **Warning**
> : As of version 1.0.0, you need to add ``import LovelyPlots`` before setting the style (``plt.style.use('ipynb')``).
> : As of version 1.0.0, you need to add ``import lovelyplots`` before setting the style (``plt.style.use('ipynb')``).
LovelyPlots is a repository containing ``matplotlib`` style sheets to nicely format figures for scientific papers, thesis and presentations while keeping them fully editable in ``Adobe Illustrator``. Additonaly, ``.svg`` exports options allows figures to automatically adapt their font to your document's font. For example, ``.svg`` figures imported in a ``.tex`` file will automatically be generated with the text font used in your ``.tex`` file.

Expand All @@ -18,7 +18,7 @@ LovelyPlots is a repository containing ``matplotlib`` style sheets to nicely for
pip install LovelyPlots

# to install latest GitHub commit
pip install --upgrade git+https://github.com/killiansheriff/LovelyPlots
pip install --upgrade git+https://github.com/killiansheriff/LovelyPlots.git
```

The pip installation will move all of the ``matplotlib`` style files ``*.mplstyle`` into the appropriate ``matplotlib`` directory.
Expand Down Expand Up @@ -128,7 +128,7 @@ By default the ``ipynb`` style uses the default ``matplotlib`` font. However, on

```python
import matplotlib.pyplot as plt
import LovelyPlots.utils as lp
import lovelyplots.utils as lp

plt.style.use('ipynb')
lp.set_font('my_font.tiff')
Expand Down Expand Up @@ -164,13 +164,13 @@ For those using ``IPython`` notebooks, you can set retina display support by add


```python
import LovelyPlots.utils as lp
import lovelyplots.utils as lp
lp.set_retina()
```
## Useth in Google Colab
To use on Google Colab, you will need to run the following code:
```python
!pip install LovelyPlots
!pip install lovelyplots
plt.style.reload_library()
plt.style.use('ipynb')
```
Expand Down
5 changes: 3 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
"""

import os

from setuptools import setup

# Get description from README
Expand All @@ -28,9 +29,9 @@
license="MIT",
url="https://github.com/killiansheriff/LovelyPlots",
install_requires=['matplotlib'],
packages=["LovelyPlots"],
packages=["lovelyplots"],
package_data={
'LovelyPlots': ['styles/**/*.mplstyle'],
'lovelyplots': ['styles/**/*.mplstyle'],
},

classifiers=[
Expand Down

0 comments on commit 62e2942

Please sign in to comment.