Merge pull request #163 from ImperialCollegeLondon/feat/package

feat: Convert MATLAB Project to MATLAB Package

Author: mfacchinelli

.env

@@ -17,8 +17,9 @@ jobs:
         uses: matlab-actions/[email protected]
         with:
           release: R2025a
-      - name: Load Environment Variables
-        uses: aarcangeli/[email protected]
+      - name: Load version from package
+        run: |
+          echo "MAG_DATA_VISUALIZATION_VERSION=$(jq -r .version resources/mpackage.json)" >> $GITHUB_ENV
       - name: Validate version with tag
         run: |
           if [ "v${{ env.MAG_DATA_VISUALIZATION_VERSION }}" != "${{ github.ref_name }}" ]; then

.github/workflows/package.yml

@@ -11,7 +11,7 @@ repos:
       - id: trailing-whitespace
       - id: pretty-format-json
         args: [--autofix, --indent, "4"]
-        exclude: resources/codeAnalyzerConfiguration.json|tests/unit/data/imap/test_data/invalid.json
+        exclude: resources/codeAnalyzerConfiguration.json|resources/mpackage.json|tests/unit/data/imap/test_data/invalid.json
   - repo: https://github.com/python-jsonschema/check-jsonschema
     rev: "0.33.0"
     hooks:

.pre-commit-config.yaml

@@ -1,21 +1,23 @@
 function plan = buildfile()
 % BUILDFILE File invoked by automated build.
 
-    % Create a plan from task functions.
     plan = buildplan();
 
-    % Get current project.
     if isMATLABReleaseOlderThan("R2025a")
 
-        project = matlab.project.currentProject();
+        warning("mag:buildtool:path", "MATLAB release ""%s"" not supported for development purposes. " + ...
+            "Adding all folders to the path for testing purposes.", matlabRelease().Release);
 
-        if isempty(project) || ~isequal(project.Name, "MAG Data Visualization")
+        % Brute-force add all folders to the path.
+        addpath(genpath(plan.RootFolder));
+    else
+
+        % Open package if not already open.
+        package = matlab.mpm.Package(plan.RootFolder);
 
-            project = matlab.project.loadProject("MAGDataVisualization.prj");
-            restoreProject = onCleanup(@() project.close());
+        if ~package.Installed
+            addpath(join(fullfile(plan.RootFolder, [package.Folders.Path]), pathsep()));
         end
-    else
-        project = plan.Project;
     end
 
     % Add the "check" task to identify code issues.
@@ -34,9 +36,13 @@
         TestResults = fullfile("artifacts/results.xml"), ...
         CodeCoverageResults = fullfile("artifacts/coverage.xml"));
 
+    if ~isMATLABReleaseOlderThan("R2025a")
+        plan("test").RunOnlyImpactedTests = true;
+    end
+
     % Add the "package" task to create toolbox.
     plan("package") = mag.buildtool.task.PackageTask(Description = "Package code into toolbox", ...
-        ProjectRoot = project.RootFolder, ...
+        PackageRoot = plan.RootFolder, ...
         ToolboxPath = fullfile("artifacts/MAG Data Visualization.mltbx"));
 
     % Add the "clean" task to delete output of all tasks.

MAGDataVisualization.prj

@@ -0,0 +1,16 @@
+{
+    "mw.desktop.quickAccess": {
+        "items": [
+            {
+                "action": {
+                    "callback": "DataVisualization",
+                    "description": "Open MAG Data Visualization App",
+                    "icon": "../icons/mag.png",
+                    "text": "Data Visualization App"
+                },
+                "name": "mag.ui.DataVisualization",
+                "type": "PushButton"
+            }
+        ]
+    }
+}

README.md

@@ -0,0 +1,110 @@
+{
+    "name": "MAGDataVisualization",
+    "version": "8.0.0",
+    "id": "69962df8-e93e-47cd-a1d6-766ad3e9da8a",
+    "formerNames": [],
+    "displayName": "MAG Data Visualization",
+    "summary": "MAG data visualization toolbox",
+    "description": "MAG toolbox for processing and visualizing magnetometer data and housekeeping",
+    "provider": {
+        "name": "Michele Facchinelli",
+        "organization": "Imperial College London",
+        "email": "",
+        "url": "https://www.imperial.ac.uk/space-and-atmospheric-physics/research/areas/space-magnetometer-laboratory/"
+    },
+    "folders": [
+        {
+            "path": "app",
+            "languages": [
+                "matlab"
+            ]
+        },
+        {
+            "path": "app/core",
+            "languages": [
+                "matlab"
+            ]
+        },
+        {
+            "path": "src/visualize",
+            "languages": [
+                "matlab"
+            ]
+        },
+        {
+            "path": "tests/tool",
+            "languages": [
+                "matlab"
+            ]
+        },
+        {
+            "path": "app/mission/bart",
+            "languages": [
+                "matlab"
+            ]
+        },
+        {
+            "path": "app/mission/hs",
+            "languages": [
+                "matlab"
+            ]
+        },
+        {
+            "path": "app/mission/imap",
+            "languages": [
+                "matlab"
+            ]
+        },
+        {
+            "path": "src/analyze",
+            "languages": [
+                "matlab"
+            ]
+        },
+        {
+            "path": "src/data",
+            "languages": [
+                "matlab"
+            ]
+        },
+        {
+            "path": "src/io",
+            "languages": [
+                "matlab"
+            ]
+        },
+        {
+            "path": "src/mission/bart",
+            "languages": [
+                "matlab"
+            ]
+        },
+        {
+            "path": "src/mission/hs",
+            "languages": [
+                "matlab"
+            ]
+        },
+        {
+            "path": "src/mission/imap",
+            "languages": [
+                "matlab"
+            ]
+        },
+        {
+            "path": "src/transform",
+            "languages": [
+                "matlab"
+            ]
+        },
+        {
+            "path": "src/utility",
+            "languages": [
+                "matlab"
+            ]
+        }
+    ],
+    "dependencies": [],
+    "releaseCompatibility": ">=R2024a",
+    "schemaVersion": "1.1.0"
+}