small changes

.github/workflows/main.yml

@@ -36,6 +36,12 @@ jobs:
 
             pip install pylint
             pylint $(git ls-files '*.py')
+      - name: Install packages for spell check and perform spell check
+        run: |
+          sudo apt install aspell-en
+          pip install pyspelling
+          pyspelling
+          echo finished spell checking
 
       - name: install femmt package
         run: |

.gitignore

@@ -39,6 +39,7 @@ femmt.egg-info/
 onelab/
 */working_directory/
 tests/integration/temp/
+docs/_templates/
 
 # FEMMT: generated files
 femmt/electro_magnetic/Parameter.pro
@@ -76,3 +77,6 @@ femmt/thermal/solver/PostOperation.pro
 femmt/examples/paper_thermal_validation.py
 !femmt/examples/example_log.json
 femmt/examples/example_results
+
+# pyspelling
+dictionary.dic

.pyspelling.yml

@@ -0,0 +1,37 @@
+matrix:
+- name: Python Source
+  aspell:
+    lang: en
+    d: en_US
+  sources:
+  - femmt/*.py
+  - femmt/*/*.py
+  dictionary:
+    wordlists:
+      - docs/wordlist
+  pipeline:
+  - pyspelling.filters.python:
+      strings: true
+      comments: false
+  ignore_regexp:
+        - '.*\b(TODO|FIXME|NOTE)\b.*'
+- name: markdown
+  sources:
+  - README.rst
+  #- CHANGELOG.md
+  aspell:
+    lang: en
+    d: en_US
+  dictionary:
+    wordlists:
+    - docs/wordlist
+  pipeline:
+  - pyspelling.filters.markdown:
+  - pyspelling.filters.html:
+      comments: false
+      attributes:
+      - title
+      - alt
+      ignores:
+      - code
+      - pre

README.rst

@@ -39,7 +39,7 @@ Stable features
          * Litz wire database
          * Core geometry database
          * Conductor materials: temperature curves
-         * Ferrit materials: permeability / permittivity `material database <https://github.com/upb-lea/materialdatabase>`__ (datasheets and own measurements)
+         * Ferrite materials: permeability / permittivity `material database <https://github.com/upb-lea/materialdatabase>`__ (datasheets and own measurements)
 
 * Solver features:
     * Implemented using `ONELAB <https://onelab.info/>`__
@@ -63,7 +63,7 @@ Stable features
     * Transformer equivalent diagrams for 2- and 3-winding transformer
 
 * Optimization:
-    * Parallel computing to speed up simulations (no cpu core limitation)
+    * Parallel computing to speed up simulations (no CPU core limitation)
     * Examples for Pareto optimization to adapt to your own optimization problem
 
 
@@ -124,7 +124,7 @@ Further steps for macOS(ARM)
 -  Go to https://onelab.info/
 -  Download the Desktop Version for Windows
 -  Copy the "conveks.py" and "Onelab.py" files and paste them into the "onelab" folder
--  Go to http://getdp.info/
+-  Go to https://getdp.info/
 -  Download the macOS(ARM) Version
 -  Open the downloaded folder, navigate to "bin" and copy the "getdp" application file
 -  Paste the copied file into your "onelab" folder