Update to version 1.1.0

Author: eszmw

.gitattributes

@@ -5,18 +5,18 @@
 *.mexa64 binary
 *.mexw64 binary
 *.mexmaci64 binary
-*.mlapp binary
+*.mlapp binary linguist-language=MATLAB
 *.mldatx binary
 *.mlproj binary
-*.mlx binary merge=mlAutoMerge
+*.mlx binary merge=mlAutoMerge linguist-language=MATLAB
 *.p binary
 *.sfx binary
 *.sldd binary
 *.slreqx binary merge=mlAutoMerge
 *.slmx binary merge=mlAutoMerge
 *.sltx binary
 *.slxc binary
-*.slx binary merge=mlAutoMerge
+*.slx binary merge=mlAutoMerge linguist-language=Simulink
 *.slxp binary
 
 ## Other common binary file types

.gitignore

@@ -1,9 +1,59 @@
 # List of untracked files to ignore
 
+# Autosave files
 */*.asv
 *.asv
+*.m~
+*.autosave
+*.slx.r*
+*.mdl.r*
 
+# MATLAB Drive
+*.MATLABDriveTag
+
+# Compiled files
+*.mex*
+*.p
+
+# Compressed files
+*.zip
+
+# Packaged app and toolbox files
+*.mlappinstall
+*.mltbx
+
+# Deployable archives
+*.ctf
+
+# Generated helpsearch folders
+helpsearch*/
+
+# Defined Simulink cache folder
+Utilities/SimulinkCache/*
+
+# Standard code generation folders
+slprj/
+sccprj/
+codegen/
+
+# Code generation file
+*.eep
+*.elf
+*.hex
+*.bin
+
+# Cache files
+*.slxc
+
+# Project settings and other local data
+Utilities/ProjectSettings.mat
 Data/allStorms.mat
 Data/allStorms.csv
+Scripts/myLakeData.mat
+myLakeData.mat
+
+# Test results
+SoftwareTests/TestResults_*
 
-Solutions.zip
+# GitLab page folder
+public/

.gitlab-ci.yml

@@ -0,0 +1,98 @@
+stages:         
+# Set up two testing paths
+  - setup
+  - test
+  - deploy
+  - release
+
+setup-job:
+    tags:
+      - matlab
+    stage: setup
+    script:
+      - cd ..
+      - if (test-path utilities) { rm -r -force utilities }
+      - git clone [email protected]:modular-curriculum-content/utilities.git
+      - cd $CI_PROJECT_NAME 
+    allow_failure: false
+
+
+smoke-test:
+# Smoke tests should run all the time
+    tags:
+    # Add additional tags like (e.g. - arduino) as required
+    # Make sure that the runner you plan to use matches the tags
+      - matlab
+    stage: test
+    script: 
+      - matlab -batch "openProject(pwd);RunAllTests(true)"
+    when: always
+    allow_failure: true
+    artifacts:
+      paths:
+        - public/*
+      expire_in: 1 years
+
+pages:
+    tags:
+      - matlab
+    stage: deploy
+    script:
+      - echo 'Deploying pages'
+    artifacts:
+        paths:
+            - public
+
+smoke-test-solution:
+    tags:
+      - matlab
+    stage: release
+    script: 
+      - matlab -batch "proj = openProject(pwd); 
+        addpath(genpath(proj.RootFolder));
+        results = runtests(fullfile('InternalFiles','Tests','CI','SolnSmokeTests.m'));
+        disp(table(results)); assertSuccess(results);"
+    rules:
+# This test should always run when merging to main
+# And be available for manual running on any push
+      - if: $CI_MERGE_REQUEST_TARGET_BRANCH_NAME == $CI_DEFAULT_BRANCH
+        when: always
+      - if: $CI_MERGE_REQUEST_TARGET_BRANCH_NAME != $CI_DEFAULT_BRANCH
+        when: manual
+    allow_failure: true
+        
+file-test:   
+    tags:
+      - matlab
+    stage: release
+    script: 
+      - matlab -batch "proj = openProject(pwd); 
+        addpath(proj.RootFolder+'/InternalFiles/Tests/CI');
+        results = runtests('OpenCloseFileTest.m');
+        disp(table(results)); assertSuccess(results);"
+    rules:
+# This test should always run when merging to main
+# And be available for manual running on any push
+      - if: $CI_MERGE_REQUEST_TARGET_BRANCH_NAME == $CI_DEFAULT_BRANCH
+        when: always
+      - if: $CI_MERGE_REQUEST_TARGET_BRANCH_NAME != $CI_DEFAULT_BRANCH
+        when: manual
+    allow_failure: true
+
+release-testing:
+    tags:
+      - matlab
+    stage: release
+    script: 
+      - matlab -batch "proj = openProject(pwd); 
+        cd ..;
+        addpath(genpath(fullfile('utilities','TestingResources')));
+        runCMTests"
+    rules:
+# This test should always run when merging to main
+# And be available for manual running on any push
+      - if: $CI_MERGE_REQUEST_TARGET_BRANCH_NAME == $CI_DEFAULT_BRANCH
+        when: always
+      - if: $CI_MERGE_REQUEST_TARGET_BRANCH_NAME != $CI_DEFAULT_BRANCH
+        when: manual
+    allow_failure: true

Data/.gitkeep

@@ -0,0 +1,15 @@
+function [x,y] = CollectData()
+% figure('position',get(0,'screensize'))
+% figure("WindowState","maximized")
+figure
+axes('position',[0 0 1 1])
+grid on
+grid minor
+str = ["Select control points around your image by clicking and then double-click ", ...
+    "to finish data collection. Close the figure window to return to the script."];
+annotation("textbox",[.05 .9 .1 .1],"String",str,"FitBoxToText","on")
+ax = gca;
+roi = drawpolygon(ax);
+x = roi.Position(:,1);
+y = roi.Position(:,2);
+end

Data/BakerLake.fig

@@ -0,0 +1,8 @@
+function roi = IdentifyLakeShape
+    fig = uifigure("Name","Trace the outline of the lake");
+    gx = geoaxes("Parent",fig);
+    geoplot(gx,48.7,-121.658)
+    geolimits(gx,[48.63,48.75],[-121.665 -121.65])
+    geobasemap(gx,'satellite')
+    roi = drawpolygon(gx);
+end

Data/BakerLakeScale.fig

@@ -0,0 +1,12 @@
+function longScale = MeasureGeoScale
+    fig = uifigure("Name","Measure 2 km");
+    gx = geoaxes("Parent",fig);
+    geoplot(gx,48.7,-121.658)
+    geolimits(gx,[48.63,48.75],[-121.665 -121.65])
+    geobasemap(gx,'satellite')
+    roi = drawpolygon(gx);
+    longVals = roi.Position(:,2);
+
+    longScale = 2/(longVals(2)-longVals(1));
+
+end

Data/lakeData.mat

@@ -0,0 +1,80 @@
+function u = cnPDE(f,alpha,beta,tEnd,dx,gamma,L)
+% Solve the 1D heat equation u_t = gamma*u_{xx} on a rod of length L
+%   using the Crank-Nicolson method
+%   u(t,0) = alpha(t)
+%   u(t,L) = beta(t)
+%   u(0,x) = f(x)
+%   The desired spatial resolution is dx
+%   Output is u = u(tEnd,x_m), a vector of values on the mesh points
+
+% %% Define dt with reference to both error and stability concerns
+% Optimal step size dtOpt for stability
+dtOpt = nan;
+
+% Forcing an integer numbers of dt steps that terminate at tEnd
+dt = tEnd/ceil(tEnd/dtOpt);
+ 
+% %% Set up helper values for defining the required matrices A and B 
+% %% such as the number of rows, the value of mu, etc 
+
+
+% %% Define modA for the explicit updating rule 
+% %% modA-I = (A-I)/2, where I is the identity matrix
+
+
+% %% Define modB for the implicit updating rule 
+% %% modB-I = (B-I)/2, where I is the identity matrix
+
+
+% %% Initialize bAvg = b^(j)+b^(j+1) as a vector of zeros
+
+
+% %% Define a spatial mesh vector xVals
+xVals = [0;0;0];
+
+% %% Set up a column vector u0 of the initial values of u when t=0
+u0 = 0;
+u = u0;
+
+% %% Initialize the output to the interior points of u0 
+
+
+% To visualize the outputs
+p = plot(xVals,u0,"LineWidth",4);
+ax = p.Parent;
+
+% Set the y limits to reasonable fixed values
+minAlpha = min(alpha(0:dt:tEnd));
+maxAlpha = max(alpha(0:dt:tEnd));
+minBeta = min(beta(0:dt:tEnd));
+maxBeta = max(beta(0:dt:tEnd));
+yLower = min([ax.YLim(1),minAlpha,minBeta]);
+yUpper = max([ax.YLim(2),maxAlpha,maxBeta]);
+scale = (yUpper-yLower)*0.05;
+ax.YLim = [yLower-scale yUpper+scale];
+
+% These values generate well-sized y limits for the example function 
+% used in partialDiffEqs.mlx 
+ylim([-4 1.5]);
+title("Solving $\frac{\partial u}{\partial t} = \gamma \frac{\partial^2 u}{\partial x^2}$","Interpreter","latex")
+subtitle("$t=0$","Interpreter","latex")
+xlabel("$x$","Interpreter","latex")
+ylabel("$u$","Interpreter","latex")
+
+% %% Compute new values for halfB*u^(j+1)-b^(j+1) = halfA*u^(j)+b^(j)
+% %% Loop over timesteps to reach tEnd
+for j = 1:(tEnd/dt)
+    
+
+    % To visualize the outputs
+    hold on
+    delete(ax.Children(1:end-1));
+    plot(xVals,[alpha(j*dt);u;beta(j*dt)],"k","LineWidth",1)
+    subtitle("$t = $"+dt*j)
+    drawnow
+    pause(0.1)     
+    hold off
+    % End visualization code
+end
+
+end

Data/longLakeData.mat

@@ -0,0 +1,21 @@
+function [xApprox,yApprox]=eulerMethod(f,init,n,h)
+arguments
+    f function_handle  % integrand, e.g. @(x) x.^2
+    init (1,2) double  % initial value (x0,y0)
+    n (1,1) double {mustBePositive,mustBeInteger} % number of steps
+    h (1,1) double     % step size
+end
+
+% The function returns two length (n+1) vectors of 
+% estimated x and y values
+
+% Initialize the output with the initial value
+% Initialize the output with the initial value
+xApprox = nan(n+1,1);
+yApprox = nan(n+1,1);
+xApprox(1) = init(1);
+yApprox(1) = init(2);
+
+% Fill in the details of the implementation here
+
+end

Data/modernLakeData.mat

@@ -0,0 +1,23 @@
+function [xApprox,yApprox]=eulerMethodDE(f,init,n,h)
+arguments
+    f function_handle  % derivative dy/dt = f(t,y)
+    init (1,2) double  % initial value [t0 y0]
+    n (1,1) double {mustBePositive,mustBeInteger} % number of steps
+    h (1,1) double     % step size
+end
+% f is a function handle, e.g. @(t,y) t.^2.*cos(y)
+
+% The function returns two length (n+1) vectors of 
+% estimated x and y values
+
+% Initialize the output with the initial value
+% Initialize the output with the initial value
+xApprox = nan(n+1,1);
+yApprox = nan(n+1,1);
+xApprox(1) = init(1);
+yApprox(1) = init(2);
+
+% Fill in the details of the implementation here
+
+
+end