Merge pull request #56 from jimustafa/master

add `pre-commit` workflow for whitespace checking

Author: rougier

.github/workflows/main.yaml

@@ -0,0 +1,11 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+      - uses: pre-commit/[email protected]

.pre-commit-config.yaml

@@ -0,0 +1,15 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.4.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+        files: (?x)^(
+          [\w-]+[.]tex|
+          scripts/[\w-]+[.]py|
+          )$
+      - id: trailing-whitespace
+        files: (?x)^(
+          [\w-]+[.]tex|
+          scripts/[\w-]+[.]py|
+          )$

handout-beginner.tex

@@ -181,7 +181,7 @@ \subsection*{\rmfamily Tweak}
 % -----------------------------------------------------------------------------
 You can modify pretty much anything in a plot, including limits,
 colors, markers, line width and styles, ticks and ticks labels,
-titles, etc. \medskip 
+titles, etc. \medskip
 
 % -----------------------------------------------------------------------------
 \begin{tabular}{@{}m{.821\linewidth}m{.169\linewidth}}
@@ -302,4 +302,3 @@ \subsection*{\rmfamily Save \mdseries (bitmap or vector format)}
 
 \end{multicols*}
 \end{document}
-

handout-intermediate.tex

@@ -75,7 +75,7 @@ \section*{\LARGE \rmfamily
 
 A matplotlib figure is composed of a hierarchy of elements that forms
 the actual figure. Each element can be modified. \medskip
-  
+
 \includegraphics[width=\linewidth]{anatomy-cropped.pdf}
 
 \subsection*{\rmfamily Figure, axes \& spines}
@@ -204,4 +204,3 @@ \subsection*{\rmfamily Size \& DPI}
 
 \end{multicols*}
 \end{document}
-

handout-tips.tex

@@ -87,7 +87,7 @@ \subsection*{\rmfamily Transparency}
 \begin{tabular}{@{}m{.774\linewidth}m{.216\linewidth}}
 \begin{lstlisting}[belowskip=-\baselineskip]
  X = np.random.normal(-1,1,500)
- Y = np.random.normal(-1,1,500)  
+ Y = np.random.normal(-1,1,500)
  ax.scatter(X, Y, 50, "0.0", lw=2) # optional
  ax.scatter(X, Y, 50, "1.0", lw=0) # optional
  ax.scatter(X, Y, 40, "C1",  lw=0, alpha=0.1)
@@ -102,7 +102,7 @@ \subsection*{\rmfamily Rasterization}
 in vector format.
 \begin{lstlisting}
  X = np.random.normal(-1, 1, 10_000)
- Y = np.random.normal(-1, 1, 10_000)  
+ Y = np.random.normal(-1, 1, 10_000)
  ax.scatter(X, Y, rasterized=True)
  fig.savefig("rasterized-figure.pdf", dpi=600)
 \end{lstlisting}
@@ -117,7 +117,7 @@ \subsection*{\rmfamily Offline rendering}
  ... # draw som stuff
  canvas.draw()
  Z = np.array(canvas.renderer.buffer_rgba())
-\end{lstlisting} 
+\end{lstlisting}
 
 % -----------------------------------------------------------------------------
 \subsection*{\rmfamily Range of continuous colors}
@@ -127,7 +127,7 @@ \subsection*{\rmfamily Range of continuous colors}
  X = np.random.randn(1000, 4)
  cmap = plt.get_cmap("Oranges")
  colors = cmap([0.2, 0.4, 0.6, 0.8])
- 
+
  ax.hist(X, 2, histtype='bar', color=colors)
 \end{lstlisting} &
 \raisebox{-0.75em}{\includegraphics[width=\linewidth]{tip-color-range.pdf}}
@@ -166,9 +166,9 @@ \subsection*{\rmfamily Dotted lines}
 To have rounded dotted lines, use a custom {\ttfamily linestyle} and
 modify {\ttfamily dash\_capstyle}.
 \begin{lstlisting}
- ax.plot([0,1], [0,0], "C1", 
+ ax.plot([0,1], [0,0], "C1",
         linestyle = (0, (0.01, 1)), dash_capstyle="round")
- ax.plot([0,1], [1,1], "C1", 
+ ax.plot([0,1], [1,1], "C1",
         linestyle = (0, (0.01, 2)), dash_capstyle="round")
 \end{lstlisting}
 \includegraphics[width=\linewidth]{tip-dotted.pdf}
@@ -194,7 +194,7 @@ \subsection*{\rmfamily Colorbar adjustment}
 \begin{tabular}{@{}m{.754\linewidth}m{.236\linewidth}}
 \begin{lstlisting}[belowskip=-\baselineskip]
  im = ax.imshow(Z)
-  
+
  cb = plt.colorbar(im,
          fraction=0.046, pad=0.04)
  cb.set_ticks([])

scripts/adjustements.py

@@ -64,7 +64,7 @@ def ext_arrow(p0,p1,p2,p3):
     p0, p1 = np.asarray(p0), np.asarray(p1)
     p2, p3 = np.asarray(p2), np.asarray(p3)
     ax.arrow(*p0, *(p1-p0), zorder=20, linewidth=0,
-             length_includes_head=True, width=.4, 
+             length_includes_head=True, width=.4,
              head_width=2, head_length=2, color="black")
     ax.arrow(*p3, *(p2-p3), zorder=20, linewidth=0,
              length_includes_head=True, width=.4,
@@ -74,13 +74,13 @@ def ext_arrow(p0,p1,p2,p3):
 def int_arrow(p0,p1):
     p0, p1 = np.asarray(p0), np.asarray(p1)
     ax.arrow(*((p0+p1)/2), *((p1-p0)/2), zorder=20, linewidth=0,
-             length_includes_head=True, width=.4, 
+             length_includes_head=True, width=.4,
              head_width=2, head_length=2, color="black")
     ax.arrow(*((p0+p1)/2), *(-(p1-p0)/2), zorder=20, linewidth=0,
-             length_includes_head=True, width=.4, 
+             length_includes_head=True, width=.4,
              head_width=2, head_length=2, color="black")
 
-    
+
 
 x = 0
 y = 10

scripts/advanced-plots.py

@@ -3,7 +3,7 @@
 # Released under the BSD License
 # -----------------------------------------------------------------------------
 
-# Scripts to generate all the basic plots 
+# Scripts to generate all the basic plots
 import numpy as np
 import matplotlib as mpl
 import matplotlib.pyplot as plt
@@ -149,4 +149,3 @@
 ax.grid(linewidth=0.125)
 plt.savefig("../figures/advanced-xcorr.pdf")
 ax.clear()
-

scripts/basic-plots.py

@@ -3,7 +3,7 @@
 # Released under the BSD License
 # -----------------------------------------------------------------------------
 
-# Scripts to generate all the basic plots 
+# Scripts to generate all the basic plots
 import numpy as np
 import matplotlib as mpl
 import matplotlib.pyplot as plt
@@ -56,7 +56,7 @@
 np.random.seed(3)
 X = 0.5 + np.arange(8)
 Y = np.random.uniform(2, 7, len(X))
-ax.bar(X, Y, bottom=0, width=1, 
+ax.bar(X, Y, bottom=0, width=1,
        edgecolor="white", facecolor="C1", linewidth=0.25)
 ax.set_xlim(0, 8), ax.set_xticks(np.arange(1,8))
 ax.set_ylim(0, 8), ax.set_yticks(np.arange(1,8))
@@ -110,9 +110,9 @@
 ax.set_ylim(0, 8), ax.set_yticks(np.arange(1,8))
 ax.set_axisbelow(True)
 ax.grid(linewidth=0.25, color="0.75")
-ax.pie(X, colors=["white",]*len(X), radius=3, center=(4,4), 
+ax.pie(X, colors=["white",]*len(X), radius=3, center=(4,4),
         wedgeprops = {"linewidth": 0.25, "edgecolor": "white"}, frame=True)
-ax.pie(X, colors=colors, radius=3, center=(4,4), 
+ax.pie(X, colors=colors, radius=3, center=(4,4),
         wedgeprops = {"linewidth": 0.25, "edgecolor": "white"}, frame=True)
 plt.savefig("../figures/basic-pie.pdf")
 ax.clear()
@@ -158,4 +158,3 @@
 ax.grid(linewidth=0.125, color="0.75")
 plt.savefig("../figures/basic-quiver.pdf")
 ax.clear()
-

scripts/colormaps.py

@@ -11,7 +11,7 @@
 # Uniform colormaps
 # -----------------------------------------------------------------------------
 cmaps = ('viridis', 'plasma', 'inferno', 'magma', 'cividis',
-         
+
          'PRGn', 'PiYG', 'RdYlGn', 'BrBG', 'RdGy', 'PuOr', 'RdBu',
          'RdYlBu',  'Spectral', 'coolwarm', 'bwr', 'seismic',
 
@@ -23,7 +23,7 @@
          'PuRd', 'RdPu', 'BuPu', 'Purples', 'YlGnBu', 'Blues',
          'PuBu', 'GnBu', 'PuBuGn', 'BuGn','Greens', 'YlGn',
 
-         'bone', 'gray', 'pink', 'afmhot', 'hot', 'gist_heat', 'copper', 
+         'bone', 'gray', 'pink', 'afmhot', 'hot', 'gist_heat', 'copper',
          'Wistia', 'autumn', 'summer', 'spring', 'cool', 'winter',
 
          'twilight', 'twilight_shifted', 'hsv',
@@ -41,7 +41,7 @@
     if cmap in ['Set3']: n = 12
     if cmap in ['Greys']: n = 11
     Z = np.linspace(0,1,n).reshape(1,n)
-        
+
     ax.imshow(Z, extent=[xmin, xmax, ymin, ymax], cmap=plt.get_cmap(cmap))
     ax.set_xlim(xmin, xmax), ax.set_xticks([])
     ax.set_ylim(ymin, ymax), ax.set_yticks([])
@@ -61,6 +61,6 @@
             ax.text(x[i], (ymin+ymax)/2, text, color=color, zorder=10,
                     family = "Source Pro Serif", size=10, ha="center", va="center")
     """
-    
+
     plt.savefig("../figures/colormap-%s.pdf" % cmap)
     ax.clear()

scripts/colors.py

@@ -35,6 +35,6 @@
         text = str(colors[i]).replace(' ', '')
         ax.text((i+0.5)*dx, (ymin+ymax)/2, text, color=color, zorder=10,
                 family = "Source Code Pro", size=9, ha="center", va="center")
-         
+
     plt.savefig("../figures/colors-%s.pdf" % name)
     ax.clear()