updated files for release.

Author: callieEDU

.gitlab-ci.yml

@@ -1,94 +1,87 @@
 stages:         
+# Set up two testing paths
+  - setup
   - test
   - deploy
   - release
 
-.setup_matlab_linux: &setup_matlab_linux
-  # install gstreamer libraries for audio/video file support
-  - export DEBIAN_FRONTEND=noninteractive && apt-get update -y && apt-get install --no-install-recommends -y libgstreamer1.0-0 gstreamer1.0-tools gstreamer1.0-libav gstreamer1.0-plugins-base gstreamer1.0-plugins-good gstreamer1.0-plugins-bad gstreamer1.0-plugins-ugly
-  - apt-get clean && apt-get -y autoremove && rm -rf /var/lib/apt/lists/*
-  - export MLM_LICENSE_TOKEN="$LICENSEOWNER|$LICENSELABEL|$LICENSETOKEN" # Set the batch token license
-  - apt-get update
-  - apt-get install --no-install-recommends --yes git wget ca-certificates xvfb
-  - wget -q https://www.mathworks.com/mpm/glnxa64/mpm -P /opt/
-  - chmod +x /opt/mpm
-  - /opt/mpm install --release=$VERSION --destination=/opt/matlab --products=MATLAB $PRODUCT
-  - wget -O /opt/matlab/bin/matlab-batch https://ssd.mathworks.com/supportfiles/ci/matlab-batch/v1/glnxa64/matlab-batch 
-  - chmod +x /opt/matlab/bin/matlab-batch
-
-.setup_matlab_windows: &setup_matlab_windows
-  - $env:MLM_LICENSE_TOKEN="$LICENSEOWNER|$LICENSELABEL|$LICENSETOKEN" # Set the batch token license
-  - Set-Alias -Name matlab -Value "D:\MATLAB\$VERSION\bin\matlab-batch"
+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
 
-# test-linux:
-#     image: mathworks/matlab-deps:latest
-#     variables:
-#       PRODUCT: "Curve_Fitting_Toolbox Simscape Simscape_Battery Simscape_Electrical Simulink Statistics_and_Machine_Learning_Toolbox Symbolic_Math_Toolbox"
-#     parallel:
-#       matrix:
-#         - VERSION: [R2024b]
-#     tags:
-#       - training
-#       - linux
-#       - docker
-#     stage: test
-#     script:
-#       - *setup_matlab_linux
-#       - xvfb-run /opt/matlab/bin/matlab-batch "openProject(pwd); buildtool -continueOnFailure test:scripts test:models;"
-#     allow_failure: true
-#     artifacts:
-#       name: "Linux$VERSION"
-#       paths:
-#         - public/*
 
-test-windows:
-  parallel:
-    matrix:
-      - VERSION: [R2024b]
-  tags:
-    - training
-    - windows
-  stage: test
-  script:
-    - *setup_matlab_windows
-    - matlab "openProject(pwd); buildtool -continueOnFailure test-scripts test-models;"
-  allow_failure: true
-  artifacts:
-      name: "Windows$VERSION"
+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
+    parallel:
+      matrix:
+        - VERSION: [R2024a,R2024b]
+    script: 
+      - Set-Alias -Name matlab -Value "C:\Program Files\MATLAB\$VERSION\bin\matlab.exe"
+      - matlab -batch "openProject(pwd);RunAllTests"
+    when: always
+    allow_failure: true
+    artifacts:
+      name: "$VERSION"
       paths:
         - public/*
-  when: always
+      when:  always
+
 
-# test-internal:
-#   variables:
-#     VERSION: "R2024b"
-#     PRODUCT: ""
-#   tags:
-#     - training
-#     - linux
-#     - docker
-#   stage: test
-#   script:
-#     - *setup_matlab_linux
-#     - git clone https://ci-token:${GROUP_ACCESS_TOKEN}@insidelabs-git.mathworks.com/modular-curriculum-content/utilities.git internal-utilities -b ez-dev
-#     - xvfb-run /opt/matlab/bin/matlab-batch "openProject(pwd); addpath(genpath('internal-utilities')); buildtool -continueOnFailure test:internal;"
-#   allow_failure: true
-#   artifacts:
-#       name: "CMTests"
-#       paths:
-#         - public/*     
-        
 pages:
     tags:
-      - training
-      - windows
+      - matlab
     stage: deploy
-    variables:
-      VERSION: "R2024b"
     script:
-      - *setup_matlab_windows
-      - matlab "openProject(pwd); buildtool -continueOnFailure deploy-generate deploy-edit;"
-    allow_failure: true
+      - matlab -batch "openProject(pwd);PostSmokeTest;"
     artifacts:
         paths:
-            - public
+            - public
+        
+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')));
+        addpath(genpath(fullfile('utilities','Tools')));
+        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

Images/Decomposition.png

@@ -0,0 +1 @@
+{"schemaVersion":1,"label":"Test Status","color":"yellowgreen","message":"R"}

Images/Integration.png

@@ -2,9 +2,9 @@
 # <span style="color:rgb(213,80,0)">Engineering Problem Solving</span>
 
 
-[![View on File Exchange](https://www.mathworks.com/matlabcentral/images/matlab-file-exchange.svg)](https://www.mathworks.com/matlabcentral/fileexchange/XXXXX-PROJECTNAME) or [![Open in MATLAB Online](https://www.mathworks.com/images/responsive/global/open-in-matlab-online.svg)](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/REPO_NAME&project=EngineeringProblemSolving.prj&file=README.mlx)
+[![View on File Exchange](https://www.mathworks.com/matlabcentral/images/matlab-file-exchange.svg)](https://www.mathworks.com/matlabcentral/fileexchange/XXXXX-PROJECTNAME) or [![Open in MATLAB Online](https://www.mathworks.com/images/responsive/global/open-in-matlab-online.svg)](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/Engineering-Problem-Solving&project=EngineeringProblemSolving.prj&file=README.mlx)
 
-[![MATLAB Versions Tested](https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2FMathWorks-Teaching-Resources%2FREPO_NAME%2Frelease%2FImages%2FTestedWith.json)](https://MathWorks-Teaching-Resources.github.io/REPO_NAME)
+[![MATLAB Versions Tested](https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2FMathWorks-Teaching-Resources%2FEngineering-Problem-Solving%2Frelease%2FImages%2FTestedWith.json)](https://MathWorks-Teaching-Resources.github.io/Engineering-Problem-Solving)
 
 **Curriculum Module**
 
@@ -17,8 +17,7 @@ This curriculum module contains interactive [MATLAB® live scripts](https://www.
 
 ## Background
 
-You can use these live scripts as demonstrations in lectures, class activities, or interactive assignments outside class. This module covers concepts that involve systems engineering, general problem solving philosophy, creating and testing requirements, and verification and validation activities for a real system. It also includes interactive examples of mathematical and physical models representing real systems. The main project of this module will be developing a delivery drone using the methodologies learned throughout.
-
+This initial release of the Engineering Problem Solving courseware features one interactive script that explores problem solving philosophy with emphasis on engineering and concepts that involve systems engineering.
 
 The instructions inside the live scripts will guide you through the exercises and activities. Get started with each live script by running it one section at a time. To stop running the script or a section midway (for example, when an animation is in progress), use the <img src="Images/EndIcon.png" width="19" alt="EndIcon.png"> Stop button in the **RUN** section of the **Live Editor** tab in the MATLAB Toolstrip.
 
@@ -36,11 +35,11 @@ This module assumes knowledge of some problem solving theory. There is minimal M
 ### Accessing the Module
 ### **On MATLAB Online:**
 
-Use the [<img src="Images/OpenInMO.png" width="136" alt="OpenInMO.png">](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/REPO_NAME&project=PROJECTNAME.prj) ***(EDIT OPEN IN MATLAB ONLINE LINK ACCORDINGLY)*** link to download the module. You will be prompted to log in or create a MathWorks account. The project will be loaded, and you will see an app with several navigation options to get you started.
+Use the [<img src="Images/OpenInMO.png" width="136" alt="OpenInMO.png">](https://matlab.mathworks.com/open/github/v1?repo=MathWorks-Teaching-Resources/Engineering-Problem-Solving&project=EngineeringProblemSolving.prj) link to download the module. You will be prompted to log in or create a MathWorks account. The project will be loaded, and you will see an app with several navigation options to get you started.
 
 ### **On Desktop:**
 
-Download or clone this repository. Open MATLAB, navigate to the folder containing these scripts and double\-click on [EngineeringProblemSolving.prj](https://github.com/MathWorks-Teaching-Resources/Engineering-Problem-Solving%E2%80%8B/blob/release/EngineeringProblemSolving.prj) ***(EDIT TEXT AND HYPERLINK ACCORDINGLY)***. It will add the appropriate files to your MATLAB path and open an app that asks you where you would like to start. 
+Download or clone this repository. Open MATLAB, navigate to the folder containing these scripts and double\-click on [EngineeringProblemSolving.prj](https://github.com/MathWorks-Teaching-Resources/Engineering-Problem-Solving/blob/main/EngineeringProblemSolving.prj). It will add the appropriate files to your MATLAB path and open an app that asks you where you would like to start. 
 
 
 Ensure you have all the required products (listed below) installed. If you need to include a product, add it using the Add\-On Explorer. To install an add\-on, go to the **Home** tab and select  <img src="Images/AddOnsIcon.png" width="16" alt="AddOnsIcon.png"> **Add-Ons** > **Get Add-Ons**. 
@@ -60,19 +59,19 @@ Ensure you have all the required products (listed below) installed. If you need
 | :-: | :-- | :-- |
 | <img src="Images/TrafficPattern.png" width="171" alt="TrafficPattern.png"> <br>  | $\bullet$ Explore the fundamentals of problem solving and systems engineering <br> $\bullet$ Enhance systems thinking skills by utilizing mathematical models <br> $\bullet$ Gain insights into methodologies for effectively approaching and solving problems <br> $\bullet$ Engage in project planning and understanding customer needs <br>  | **Academic disciplines** <br> $\bullet$ All Engineering Disciplines <br>   |
 
-## [**DefiningRequirements.mlx**](DefiningRequirements.mlx) 
+## [**DefiningRequirements.mlx (planned)**] 
 |  | **In this script, students will...** <br>  | **Academic disciplines** <br>   |
 | :-: | :-- | :-- |
 | <img src="Images/RequirementsClipboard.png" width="171" alt="RequirementsClipboard.png"> <br>  | $\bullet$ Gain experience in interpreting and analyzing problem statements <br> $\bullet$ Explore different types of requirements and identify what constitutes a useful requirement <br> $\bullet$ Develop your own set of requirements for a sample problem statement <br>  | **Academic disciplines** <br> $\bullet$ All Engineering Disciplines <br>   |
 
 
-## [**SystemsDecomposition.mlx**](SystemsDecomposition.mlx) 
+## [**SystemsDecomposition.mlx (planned)**] 
 |  | **In this script, students will...** <br>  | **Academic disciplines** <br>   |
 | :-- | :-- | :-- |
 | <img src="Images/Decomposition.png" width="200" alt="Decomposition.png"> <br>  | $\bullet$ Utilize the V\-model to deconstruct your problem <br> $\bullet$ Gain expertise in deconstructing problems into manageable work components <br> $\bullet$ Conduct verification activities to ensure compliance with design criteria <br>  | **Academic disciplines** <br> $\bullet$ All Engineering Disciplines <br>   |
 
 
-## [**IntegrationAndTest.mlx**](IntegrationAndTest.mlx) 
+## [**IntegrationAndTest.mlx (planned)**] 
 |  | **In this script, students will...** <br>  | **Academic disciplines** <br>  
 | :-- | :-- | :-- |
 | <img src="Images/Integration.png" width="200" alt="Integration.png"> <br>  | $\bullet$ Utilize the V\-model to construct your solution <br> $\bullet$ Gain expertise in integrating components and conducting system\-level testing <br> $\bullet$ Conduct validation activities to ensure compliance with customer needs <br>  | **Academic disciplines** <br> $\bullet$ All Engineering Disciplines <br>   |
@@ -81,7 +80,7 @@ Ensure you have all the required products (listed below) installed. If you need
 
 # License
 
-The license for this module is available in the [LICENSE.md](https://github.com/MathWorks-Teaching-Resources/REPO_NAME/blob/release/LICENSE.md)  ***(EDIT HYPERLINK ACCORDINGLY)*** .
+The license for this module is available in the [LICENSE.md](https://github.com/MathWorks-Teaching-Resources/Engineering-Problem-Solving/blob/main/LICENSE.md).
 
 # Related Courseware Modules
 ## [Introduction to Engineering with Arduino](https://www.mathworks.com/matlabcentral/fileexchange/156477-introduction-to-engineering-with-arduino)
@@ -104,7 +103,7 @@ Or feel free to explore our other [modular courseware content](https://www.mathw
 
 # Contribute 
 
-Looking for more? Find an issue? Have a suggestion? Please contact the [MathWorks teaching resources team](mailto:%[email protected]). If you want to contribute directly to this project, you can find information about how to do so in the [CONTRIBUTING.md](https://github.com/MathWorks-Teaching-Resources/REPO_NAME/blob/release/CONTRIBUTING.md)   ***(EDIT HYPERLINK ACCORDINGLY)*** page on GitHub.
+Looking for more? Find an issue? Have a suggestion? Please contact the [MathWorks teaching resources team](mailto:%[email protected]). If you want to contribute directly to this project, you can find information about how to do so in the [CONTRIBUTING.md](https://github.com/MathWorks-Teaching-Resources/Engineering-Problem-Solving/blob/main/CONTRIBUTING.md) page on GitHub.
 
 
  *©* Copyright 2024 The MathWorks™, Inc