Add custom fonts directly to Matplotlib

This removes the need to manually install them system- or user-wide.
matplotlib · Feb 6, 2024 · 754e1f4 · 754e1f4
1 parent 05d47a5
commit 754e1f4
Show file tree

Hide file tree

Showing 41 changed files with 158 additions and 18 deletions.
diff --git a/.github/workflows/main.yaml b/.github/workflows/main.yaml
@@ -48,8 +48,6 @@ jobs:
           sudo sed -i '/disable ghostscript format types/,+6d' /etc/ImageMagick-6/policy.xml
           #
           make -C fonts/
-          cp -r fonts/ /usr/share/fonts/
-          fc-cache
           make all
       - name: Run checks
         run: |

diff --git a/.gitignore b/.gitignore
@@ -16,6 +16,7 @@ handout-*.png
 # ----------------------------------
 figures/*.pdf
 fonts/**/*.[ot]tf
+fonts/__pycache__/
 
 # html build
 docs/_build/*

diff --git a/README.md b/README.md
@@ -15,7 +15,7 @@ Beginner handout [(download pdf)](https://matplotlib.org/cheatsheets/handout-beg
 
 ## How to compile
 
-1. You need to create a `fonts` repository with:
+1. You need to fill the `fonts` directory with:
 
 * `fonts/roboto/*`           : See https://fonts.google.com/specimen/Roboto
                                 or https://github.com/googlefonts/roboto/tree/master/src/hinted
@@ -35,17 +35,6 @@ On Linux, with `make` installed, the fonts can be set up with the following comm
 make -C fonts
 ```
 
-The fonts can be made discoverable by `matplotlib` (through `fontconfig`) by creating the following in `$HOME/.config/fontconfig/fonts.conf` (see [here](https://www.freedesktop.org/software/fontconfig/fontconfig-user.html)):
-
-```xml
-<?xml version="1.0"?>
-<!DOCTYPE fontconfig SYSTEM "fonts.dtd">
-<fontconfig>
-<dir>/path/to/cheatsheets/fonts/</dir>
-...
-</fontconfig>
-```
-
 
 2. You need to generate all the figures:
 

diff --git a/fonts/custom_fonts.py b/fonts/custom_fonts.py
@@ -0,0 +1,8 @@
+from pathlib import Path
+
+from matplotlib.font_manager import fontManager
+
+
+HERE = Path(__file__).parent.resolve()
+for font in HERE.glob('*/*.[ot]tf'):
+    fontManager.addfont(font)
diff --git a/scripts/adjustements.py b/scripts/adjustements.py
@@ -2,6 +2,7 @@
 # Matplotlib cheat sheet
 # Released under the BSD License
 # -----------------------------------------------------------------------------
+import sys
 import pathlib
 
 import numpy as np
@@ -12,6 +13,9 @@
 
 
 ROOT_DIR = pathlib.Path(__file__).parent.parent
+sys.path.append(str(ROOT_DIR / "fonts"))
+import custom_fonts  # noqa
+
 
 mpl.style.use([
     ROOT_DIR / 'styles/base.mplstyle',

diff --git a/scripts/advanced-plots.py b/scripts/advanced-plots.py
@@ -4,6 +4,7 @@
 # -----------------------------------------------------------------------------
 
 # Script to generate all the advanced plots
+import sys
 import pathlib
 
 import numpy as np
@@ -12,6 +13,9 @@
 
 
 ROOT_DIR = pathlib.Path(__file__).parent.parent
+sys.path.append(str(ROOT_DIR / "fonts"))
+import custom_fonts  # noqa
+
 
 mpl.style.use([
     ROOT_DIR / 'styles/base.mplstyle',

diff --git a/scripts/anatomy.py b/scripts/anatomy.py
@@ -3,6 +3,7 @@
 # Author:  Nicolas P. Rougier
 # License: BSD
 # ----------------------------------------------------------------------------
+import sys
 import pathlib
 
 import numpy as np
@@ -12,6 +13,9 @@
 
 
 ROOT_DIR = pathlib.Path(__file__).parent.parent
+sys.path.append(str(ROOT_DIR / "fonts"))
+import custom_fonts  # noqa
+
 
 mpl.style.use([
     ROOT_DIR / 'styles/base.mplstyle',

diff --git a/scripts/annotate.py b/scripts/annotate.py
@@ -2,6 +2,7 @@
 # Matplotlib cheat sheet
 # Released under the BSD License
 # -----------------------------------------------------------------------------
+import sys
 import pathlib
 
 import numpy as np
@@ -10,6 +11,9 @@
 
 
 ROOT_DIR = pathlib.Path(__file__).parent.parent
+sys.path.append(str(ROOT_DIR / "fonts"))
+import custom_fonts  # noqa
+
 
 fig = plt.figure(figsize=(6, 1))
 # ax = plt.subplot(111, frameon=False, aspect=.1)

diff --git a/scripts/annotation-arrow-styles.py b/scripts/annotation-arrow-styles.py
@@ -1,10 +1,14 @@
+import sys
 import pathlib
 
 import matplotlib.pyplot as plt
 import matplotlib.patches as mpatches
 
 
 ROOT_DIR = pathlib.Path(__file__).parent.parent
+sys.path.append(str(ROOT_DIR / "fonts"))
+import custom_fonts  # noqa
+
 
 styles = mpatches.ArrowStyle.get_styles()
 

diff --git a/scripts/annotation-connection-styles.py b/scripts/annotation-connection-styles.py
@@ -1,10 +1,14 @@
+import sys
 import pathlib
 
 import matplotlib as mpl
 import matplotlib.pyplot as plt
 
 
 ROOT_DIR = pathlib.Path(__file__).parent.parent
+sys.path.append(str(ROOT_DIR / "fonts"))
+import custom_fonts  # noqa
+
 
 mpl.style.use([
     ROOT_DIR / 'styles/base.mplstyle',

diff --git a/scripts/basic-plots.py b/scripts/basic-plots.py
@@ -4,6 +4,7 @@
 # -----------------------------------------------------------------------------
 
 # Script to generate all the basic plots
+import sys
 import pathlib
 
 import numpy as np
@@ -12,6 +13,9 @@
 
 
 ROOT_DIR = pathlib.Path(__file__).parent.parent
+sys.path.append(str(ROOT_DIR / "fonts"))
+import custom_fonts  # noqa
+
 
 mpl.style.use([
     ROOT_DIR / 'styles/base.mplstyle',

diff --git a/scripts/colorbar.py b/scripts/colorbar.py
@@ -3,6 +3,7 @@
 # Released under the BSD License
 # -----------------------------------------------------------------------------
 
+import sys
 import pathlib
 
 import numpy as np
@@ -11,6 +12,9 @@
 
 
 ROOT_DIR = pathlib.Path(__file__).parent.parent
+sys.path.append(str(ROOT_DIR / "fonts"))
+import custom_fonts  # noqa
+
 
 fig = plt.figure(figsize=(6, .65))
 # ax = plt.subplot(111, frameon=False, aspect=.1)

diff --git a/scripts/colormaps.py b/scripts/colormaps.py
@@ -1,10 +1,14 @@
+import sys
 import pathlib
 
 import numpy as np
 import matplotlib.pyplot as plt
 
 
 ROOT_DIR = pathlib.Path(__file__).parent.parent
+sys.path.append(str(ROOT_DIR / "fonts"))
+import custom_fonts  # noqa
+
 
 figsize = 4.0, 0.25
 fig = plt.figure(figsize=figsize)

diff --git a/scripts/colornames.py b/scripts/colornames.py
@@ -5,13 +5,17 @@
 
 Simple plot example with the named colors and its visual representation.
 """
+import sys
 import pathlib
 
 import matplotlib as mpl
 import matplotlib.pyplot as plt
 
 
 ROOT_DIR = pathlib.Path(__file__).parent.parent
+sys.path.append(str(ROOT_DIR / "fonts"))
+import custom_fonts  # noqa
+
 
 mpl.style.use([
     ROOT_DIR / 'styles/base.mplstyle',

diff --git a/scripts/colors.py b/scripts/colors.py
@@ -3,6 +3,7 @@
 # Released under the BSD License
 # -----------------------------------------------------------------------------
 
+import sys
 import pathlib
 
 import numpy as np
@@ -11,6 +12,9 @@
 
 
 ROOT_DIR = pathlib.Path(__file__).parent.parent
+sys.path.append(str(ROOT_DIR / "fonts"))
+import custom_fonts  # noqa
+
 
 figsize = 4.0, 0.25
 fig = plt.figure(figsize=figsize)

diff --git a/scripts/extents.py b/scripts/extents.py
@@ -2,6 +2,7 @@
 # Matplotlib cheat sheet
 # Released under the BSD License
 # -----------------------------------------------------------------------------
+import sys
 import pathlib
 
 import numpy as np
@@ -10,6 +11,9 @@
 
 
 ROOT_DIR = pathlib.Path(__file__).parent.parent
+sys.path.append(str(ROOT_DIR / "fonts"))
+import custom_fonts  # noqa
+
 
 mpl.style.use([
     ROOT_DIR / 'styles/base.mplstyle',

diff --git a/scripts/fonts.py b/scripts/fonts.py
@@ -2,12 +2,16 @@
 # Matplotlib cheat sheet
 # Released under the BSD License
 # -----------------------------------------------------------------------------
+import sys
 import pathlib
 
 import matplotlib.pyplot as plt
 
 
 ROOT_DIR = pathlib.Path(__file__).parent.parent
+sys.path.append(str(ROOT_DIR / "fonts"))
+import custom_fonts  # noqa
+
 
 fig = plt.figure(figsize=(4.25, 3.8))
 ax = fig.add_axes([0, 0, 1, 1], frameon=False, xticks=[], yticks=[],
@@ -17,13 +21,13 @@
 
 # -----------------------------------------------------------------------------
 variants = {
-    "normal" : "../fonts/eb-garamond/EBGaramond08-Regular.otf",
-    "small-caps" : "../fonts/eb-garamond/EBGaramondSC08-Regular.otf"
+    "normal": "EB Garamond",
+    "small-caps": "EB Garamond SC",
 }
 
 text = "The quick brown fox jumps over the lazy dog"
-for i, (variant, file) in enumerate(variants.items()):
-    ax.text(1, y, text, size=9, va="center", font=pathlib.Path(file).resolve())
+for i, (variant, family) in enumerate(variants.items()):
+    ax.text(1, y, text, size=9, va="center", family=family)
 
     ax.text(39, y, variant,
             color="0.25", va="center", ha="right",

diff --git a/scripts/interpolations.py b/scripts/interpolations.py
@@ -1,3 +1,4 @@
+import sys
 import pathlib
 
 import matplotlib as mpl
@@ -6,6 +7,9 @@
 
 
 ROOT_DIR = pathlib.Path(__file__).parent.parent
+sys.path.append(str(ROOT_DIR / "fonts"))
+import custom_fonts  # noqa
+
 
 mpl.style.use([
     ROOT_DIR / 'styles/base.mplstyle',

diff --git a/scripts/layouts.py b/scripts/layouts.py
@@ -2,6 +2,7 @@
 # Matplotlib cheat sheet
 # Released under the BSD License
 # -----------------------------------------------------------------------------
+import sys
 import pathlib
 
 import numpy as np
@@ -11,6 +12,9 @@
 
 
 ROOT_DIR = pathlib.Path(__file__).parent.parent
+sys.path.append(str(ROOT_DIR / "fonts"))
+import custom_fonts  # noqa
+
 
 fig = plt.figure(figsize=(0.4, 0.4))
 margin = 0.01

diff --git a/scripts/legend.py b/scripts/legend.py
@@ -2,6 +2,7 @@
 # Matplotlib cheat sheet
 # Released under the BSD License
 # -----------------------------------------------------------------------------
+import sys
 import pathlib
 
 import numpy as np
@@ -10,6 +11,9 @@
 
 
 ROOT_DIR = pathlib.Path(__file__).parent.parent
+sys.path.append(str(ROOT_DIR / "fonts"))
+import custom_fonts  # noqa
+
 
 mpl.style.use([
     ROOT_DIR / 'styles/base.mplstyle',

diff --git a/scripts/linestyles.py b/scripts/linestyles.py
@@ -2,13 +2,17 @@
 # Matplotlib cheat sheet
 # Released under the BSD License
 # -----------------------------------------------------------------------------
+import sys
 import pathlib
 
 import numpy as np
 import matplotlib.pyplot as plt
 
 
 ROOT_DIR = pathlib.Path(__file__).parent.parent
+sys.path.append(str(ROOT_DIR / "fonts"))
+import custom_fonts  # noqa
+
 
 fig = plt.figure(figsize=(4.25, 2*.55))
 ax = fig.add_axes([0, 0, 1, 1], xlim=[0.75, 10.25], ylim=[0.5, 2.5], frameon=False,

diff --git a/scripts/markers.py b/scripts/markers.py
@@ -2,13 +2,17 @@
 # Matplotlib cheat sheet
 # Released under the BSD License
 # -----------------------------------------------------------------------------
+import sys
 import pathlib
 
 import numpy as np
 import matplotlib.pyplot as plt
 
 
 ROOT_DIR = pathlib.Path(__file__).parent.parent
+sys.path.append(str(ROOT_DIR / "fonts"))
+import custom_fonts  # noqa
+
 
 # Markers
 # -----------------------------------------------------------------------------

diff --git a/scripts/plot-variations.py b/scripts/plot-variations.py
@@ -2,6 +2,7 @@
 # Matplotlib cheat sheet
 # Released under the BSD License
 # -----------------------------------------------------------------------------
+import sys
 import pathlib
 
 # Scripts to generate all the basic plots
@@ -11,6 +12,9 @@
 
 
 ROOT_DIR = pathlib.Path(__file__).parent.parent
+sys.path.append(str(ROOT_DIR / "fonts"))
+import custom_fonts  # noqa
+
 
 mpl.style.use([
     ROOT_DIR / 'styles/base.mplstyle',