codespell: add config and action to codespell the code to avoid known typos

.codespellrc

@@ -0,0 +1,5 @@
+[codespell]
+skip = .git,*.pdf,*.svg
+# some abbreviated citations etc
+ignore-regex = .*Reson\. Ser.*
+ignore-words-list = te,fo,nd,maked,datas,iten,itel,tread

.github/workflows/codespell.yml

@@ -0,0 +1,22 @@
+---
+name: Codespell
+
+on:
+  push:
+    branches: [dev]
+  pull_request:
+    branches: [dev]
+
+permissions:
+  contents: read
+
+jobs:
+  codespell:
+    name: Check for spelling errors
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Codespell
+        uses: codespell-project/actions-codespell@v2

pypulseq/Sequence/sequence.py

@@ -882,7 +882,7 @@ def plot(
 
         Parameters
         ----------
-        label : str, defualt=str()
+        label : str, default=str()
             Plot label values for ADC events: in this example for LIN and REP labels; other valid labes are accepted as
             a comma-separated list.
         save : bool, default=False

pypulseq/event_lib.py

@@ -6,7 +6,7 @@
 
 class EventLibrary:
     """
-    Defines an event library ot maintain a list of events. Provides methods to insert new data and find existing data.
+    Defines an event library to maintain a list of events. Provides methods to insert new data and find existing data.
 
     Sequence Properties:
     - keys - A list of event IDs

pypulseq/seq_examples/scripts/write_MPRAGE.py

@@ -100,7 +100,7 @@ def main(plot: bool, write_seq: bool, seq_filename: str = "mprage_pypulseq.seq")
 
     # Calculate timing of the fast loop. We will have two blocks in the inner loop:
     # 1: spoilers/rewinders + RF
-    # 2: prewinder, phase enconding + readout
+    # 2: prewinder, phase encoding + readout
     rf.delay = pp.calc_duration(gro_Sp, gpe1, gpe2)
     gro_pre, _, _ = pp.align(right=[gro_pre, gpe1, gpe2])
     gro1.delay = pp.calc_duration(gro_pre)