Follow MATLAB Toolbox Best Practices

.github/workflows/tests.yml

@@ -0,0 +1,20 @@
+name: Tests
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches: [master]
+
+jobs:
+  octave:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v3
+      - name: Install Octave
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y octave
+      - name: Run OTP tests
+        run: octave --eval "addpath(genpath('.')); runalltests"

OTP.m

@@ -2,7 +2,7 @@
     properties (Access = private, Constant)
         Octave = exist('OCTAVE_VERSION', 'builtin') > 0
         Name = 'ODE Test Problems';
-        SrcDir = 'src';
+        SrcDir = 'toolbox';
         BuildDir = 'build';
     end
 
@@ -18,7 +18,7 @@ function build()
                 OTP.processFiles(OTP.SrcDir, fullfile(OTP.BuildDir, 'inst'), ...
                     {}, {});
                 copyfile('DESCRIPTION', OTP.BuildDir);
-                copyfile('LICENSE', fullfile(OTP.BuildDir, 'COPYING'));
+                copyfile('license.txt', fullfile(OTP.BuildDir, 'COPYING'));
                 zip(OTP.packagePath(), OTP.BuildDir);
             else
                 OTP.processFiles(OTP.SrcDir, OTP.BuildDir, ...

docs/Makefile

@@ -11,15 +11,12 @@ html: problems
 problems:
 	python3 generate_problem_rst.py
 
-problems: clean
-	mkdir -p build/problems
-	python3 generate_problem_rst.py
-
 install:
 	pip3 install -r requirements.txt
 
 serve:
-	sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) --watch ../src --pre-build 'make problems' --re-ignore '$(PROBLEMSDIR)/*'
+	sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) --watch '../toolbox' --pre-build 'make problems' \
+	--re-ignore '$(PROBLEMSDIR)/*'
 
 clean:
 	rm -rf $(BUILDDIR) $(PROBLEMSDIR)

docs/conf.py

@@ -21,7 +21,7 @@
 ]
 
 primary_domain = 'mat'
-matlab_src_dir = '../src'
+matlab_src_dir = '../toolbox'
 matlab_keep_package_prefix = False
 
 autodoc_default_options = {

docs/generate_problem_rst.py

@@ -7,7 +7,7 @@
 for file in problem_dir.glob('*'):
     file.unlink()
 
-for problem in cwd.glob('../src/+otp/*/*Problem.m'):
+for problem in cwd.glob('../toolbox/+otp/*/*Problem.m'):
     with problem.open() as stream:
         problem_name = search("@otp\\.Problem\\('(.+)',",
                               stream.read()).groups()[0]

docs/index.rst

@@ -24,5 +24,5 @@ TODO: put abstract here
 
    contributing
    GitHub <https://github.com/ComputationalScienceLaboratory/ODE-Test-Problems>
-   License <https://github.com/ComputationalScienceLaboratory/ODE-Test-Problems/blob/master/LICENSE>
+   License <https://github.com/ComputationalScienceLaboratory/ODE-Test-Problems/blob/master/license.txt>
    references

src/tests/getpresets.m → tests/getpresets.m

@@ -1,6 +1,6 @@
 function presets = getpresets()
 
-entry = "+otp/";
+entry = "toolbox/+otp/";
 
 if isempty(dir(entry))
     entry = dir(which('otp.RHS'));