Add linting

Author: Steven-Roberts

.github/workflows/documentation.yml

@@ -32,6 +32,10 @@ jobs:
         working-directory: ./docs
         run: make install
 
+      - name: Lint
+        working-directory: ./docs
+        run: make lint
+
       - name: Build with Sphinx
         working-directory: ./docs
         run: make

OTP.m

@@ -44,7 +44,7 @@ function install()
                 matlab.addons.toolbox.installToolbox(OTP.packagePath());
             end
 
-            fprintf('ODE Test Problems sucessfully installed\n');
+            fprintf('ODE Test Problems successfully installed\n');
         end
 
         function uninstall()

docs/.codespellrc

@@ -0,0 +1,3 @@
+[codespell]
+skip = */build,*.ipynb
+ignore-words-list = ans,compatiblity,ue,nd

docs/Makefile

@@ -1,22 +1,25 @@
-SPHINXOPTS ?= -b dirhtml
+SPHINXOPTS ?= --builder dirhtml --fail-on-warning
 SOURCEDIR = .
 BUILDDIR = build
 PROBLEMSDIR = problems
 
-.PHONY: html problems install serve clean
+.PHONY: html problems install serve lint clean
 
 html: problems
-	sphinx-build "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)
+	sphinx-build $(SOURCEDIR) $(BUILDDIR) $(SPHINXOPTS)
 
 problems:
 	python3 generate_problem_rst.py
 
 install:
-	pip3 install -r requirements.txt
+	python3 -m pip install -r requirements.txt
 
 serve:
-	sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) --fail-on-warning --watch "../toolbox" \
-	--pre-build "make problems" --re-ignore "$(PROBLEMSDIR)/*"
+	sphinx-autobuild $(SOURCEDIR) $(BUILDDIR) $(SPHINXOPTS) --watch ../toolbox --pre-build "make problems" \
+	--ignore $(PROBLEMSDIR)
+
+lint:
+	pycodestyle .. && codespell ..
 
 clean:
 	rm -rf $(BUILDDIR) $(PROBLEMSDIR)

docs/requirements.txt

@@ -9,4 +9,5 @@ sphinxcontrib-video==0.2.1
 setuptools==75.1.0 # Now required in python 3.12+
 myst-parser==2.0.0
 pyyaml==6.0.2
-
+pycodestyle==2.12.1
+codespell==2.3.0

notebooks/quick-start.ipynb

@@ -1,6 +1,6 @@
 # Running Octave Notebooks locally
 
-You will need an environment with `octave`, `jupyterlab`, and `octave_kernel` packages. Follow these steps to install the required dependancies:
+You will need an environment with `octave`, `jupyterlab`, and `octave_kernel` packages. Follow these steps to install the required dependencies:
 
 ## Check out the repository 
 

notebooks/readme.md

@@ -1,5 +1,5 @@
 classdef Canonical < otp.ascherlineardae.AscherLinearDAEProblem
-    % The problem defined by Ascher in :cite:p:`Asc89` (sec. 2) which uses time span $t ∈ [0, 1]$ and intial condition
+    % The problem defined by Ascher in :cite:p:`Asc89` (sec. 2) which uses time span $t ∈ [0, 1]$ and initial condition
     % $[y_0, z_0]^T = [1, β]^T$.
 
     methods

toolbox/+otp/+ascherlineardae/+presets/Canonical.m

@@ -25,7 +25,7 @@
     % \end{bmatrix}.
     % $$
     %
-    % This DAE problem can be used to investigate the convergence of implcit time-stepping methods due to its stiffness
+    % This DAE problem can be used to investigate the convergence of implicit time-stepping methods due to its stiffness
     % and time-dependant mass matrix.
     %
     % Notes

toolbox/+otp/+ascherlineardae/AscherLinearDAEProblem.m

@@ -1,6 +1,6 @@
 classdef Canonical < otp.lorenz63.Lorenz63Problem
     % Original Lorenz '63 preset presented in :cite:p:`Lor63` which uses time span $t ∈ [0, 60]$, $σ = 10$, $ρ = 28$, 
-    % $β = 8/3$, and intial conditions $y_0 = [0, 1, 0]^T$.
+    % $β = 8/3$, and initial conditions $y_0 = [0, 1, 0]^T$.
 
     methods
         function obj = Canonical(varargin)

toolbox/+otp/+lorenz63/+presets/Canonical.m

@@ -1,6 +1,6 @@
 classdef LimitCycle < otp.lorenz63.Lorenz63Problem
     % Lorenz '63 preset limit cycle, a non-chaotic preset, from :cite:p:`Str18` which uses time span $t ∈ [0, 60]$,
-    % $σ = 10$, $ρ = 350$, $β = 8/3$, and intial conditions $y_0 = [0, 1, 0]^T$.
+    % $σ = 10$, $ρ = 350$, $β = 8/3$, and initial conditions $y_0 = [0, 1, 0]^T$.
 
     methods
         function obj = LimitCycle

toolbox/+otp/+lorenz63/+presets/LimitCycle.m

@@ -1,6 +1,6 @@
 classdef Surprise < otp.lorenz63.Lorenz63Problem
     % Lorenz '63 preset 'surprise' from :cite:p:`Str18` which uses time span $t ∈ [0, 60]$, σ = 10$, $ρ = 100$,
-    % $β = 8/3$, and intial conditions $y_0 = [2, 1, 1]^T$.
+    % $β = 8/3$, and initial conditions $y_0 = [2, 1, 1]^T$.
 
     methods
         function obj = Surprise

toolbox/+otp/+lorenz63/+presets/Surprise.m

@@ -11,13 +11,13 @@
         %UB is the operating voltage
         Ub %MATLAB ONLY: (1,1) {otp.utils.validation.mustBeNumerical}
 
-        %UF is an auxillary voltage
+        %UF is an auxiliary voltage
         UF %MATLAB ONLY: (1,1) {otp.utils.validation.mustBeNumerical}
 
         %ALPHA controls the current coming through the gate
         Alpha %MATLAB ONLY: (1,1) {otp.utils.validation.mustBeNumerical}
 
-        %BETA is an auxillary constant
+        %BETA is an auxiliary constant
         Beta %MATLAB ONLY: (1,1) {otp.utils.validation.mustBeNumerical}
     end