Merge pull request #16 from sbu-python-class/codespell

setup codespell action

Author: zingale

.codespellrc

@@ -1,5 +1,5 @@
 [codespell]
-skip = .git,*.bib,*.ps,*.js,*.pdf,_build,*.fodp,*.fods
+skip = .git,*.bib,*.ps,*.js,*.pdf,_build,*.fodp,*.fods,other,*.sty
 ignore-words = .codespell-ignore-words
 
 

.github/workflows/codespell.yml

@@ -0,0 +1,33 @@
+name: codespell
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  codespell:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Setup Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.14'
+          cache: "pip"
+
+      - name: Install codespell
+        run: pip install codespell jupyterlab nbconvert
+
+      - name: Preprocess notebooks
+        run: for i in $(find . -name "*.ipynb"); do jupyter nbconvert --clear-output --inplace $i; done
+
+      - name: Run codespell
+        run: |
+          codespell content
+

content/01-python/w1-python-datatypes.ipynb

@@ -784,7 +784,7 @@
     "https://docs.python.org/3/reference/expressions.html#operator-precedence\n",
     "    \n",
     "in order of precedence:\n",
-    "* quantites in `()`\n",
+    "* quantities in `()`\n",
     "* slicing, calls, subscripts\n",
     "* exponentiation (`**`)\n",
     "* `+x`, `-x`, `~x`\n",

content/09-packages/python-packages.md

@@ -9,7 +9,7 @@ The python packaging system is constantly evolving, and the current recommendati
 of tools is list here: https://packaging.python.org/en/latest/guides/tool-recommendations/
 ```
 
-![xkcd](python_environment.png)
+![xkcd comic on python packaging chaos](python_environment.png)
 
 (from https://xkcd.com)
 

content/11-machine-learning/neural-net-basics.md

@@ -43,7 +43,7 @@ Our goal is to determine the matrix elements of ${\bf A}$.
 
 We can visualize a neural network as:
 
-![NN diagram](nn_fig.png)
+![neural network diagram showing nodes in layers linked](nn_fig.png)
 
 * Neural networks are divided into _layers_
 

content/11-machine-learning/neural-net-hidden.md

@@ -3,7 +3,7 @@
 
  We can get better performance from a neural network by adding a hidden layer:
 
-![hidden layers](nn_fig_hidden.png)
+![neutron network diagram showing a single hidden layer](nn_fig_hidden.png)
 
 The size of the hidden layer is independent of the size of the input and output
 layers.  In this case, we have a hidden layer that is larger

content/Introduction.md

@@ -1,6 +1,6 @@
 # PHY 546: Python for Scientific Computing
 
-![xkcd](01-python/python.png)
+![xkcd python cartoon](01-python/python.png)
 
 (from https://xkcd.com)
 

content/git/version-control.md

@@ -6,7 +6,7 @@ You can follow the instructions from the [Software Carpentry lessons](https://ca
 
 * Windows: use [git for Windows](https://gitforwindows.org/)
 
-* Mac: in a teminal, do:
+* Mac: in a terminal, do:
 
   ```
   git --version