9.3 Deployment

.github/workflows/ci-beta.yml

@@ -0,0 +1,138 @@
+# Beta-tier proxy, BHoM variant. Bundles the tier's checks plus
+# copyright-compliance (BHoM enforces OSS copyright; the BHE variant omits it).
+# Copy to .github/workflows/ci-beta.yml in each BHoM beta repo.
+# Runs on pull_request, non-blocking until a ruleset requires its checks.
+# Workflow name CI keeps check contexts bare: required contexts are the job names.
+
+name: CI
+
+on:
+  pull_request:
+    branches:
+      - develop
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}-${{ github.event_name }}
+  cancel-in-progress: true
+
+jobs:
+  ci-build:
+    runs-on: windows-2025-vs2026
+    timeout-minutes: 30
+    steps:
+      - name: Run build
+        uses: BHoM/CI_Toolkit/.github/actions/ci-build@develop
+        with:
+          app_id: ${{ secrets.BHOM_APP_ID }}
+          private_key: ${{ secrets.BHOM_APP_PRIVATE_KEY }}
+
+  ci-code-compliance:
+    runs-on: windows-2025-vs2026
+    timeout-minutes: 20
+    permissions:
+      contents: read
+      pull-requests: read
+      actions: write
+    steps:
+      - name: Run code compliance
+        uses: BHoM/CI_Toolkit/.github/actions/ci-compliance@develop
+        with:
+          check_type: code
+          patterns: '*.cs'
+          app_id: ${{ secrets.BHOM_APP_ID }}
+          private_key: ${{ secrets.BHOM_APP_PRIVATE_KEY }}
+
+  ci-copyright-compliance:
+    runs-on: windows-2025-vs2026
+    timeout-minutes: 20
+    permissions:
+      contents: read
+      pull-requests: read
+      actions: write
+    steps:
+      - name: Run copyright compliance
+        uses: BHoM/CI_Toolkit/.github/actions/ci-compliance@develop
+        with:
+          check_type: copyright
+          patterns: '*.cs'
+          app_id: ${{ secrets.BHOM_APP_ID }}
+          private_key: ${{ secrets.BHOM_APP_PRIVATE_KEY }}
+
+  ci-dataset-compliance:
+    runs-on: windows-2025-vs2026
+    timeout-minutes: 20
+    permissions:
+      contents: read
+      pull-requests: read
+      actions: write
+    steps:
+      - name: Run dataset compliance
+        uses: BHoM/CI_Toolkit/.github/actions/ci-compliance@develop
+        with:
+          check_type: dataset
+          patterns: ':(icase)*datasets*.json'
+          app_id: ${{ secrets.BHOM_APP_ID }}
+          private_key: ${{ secrets.BHOM_APP_PRIVATE_KEY }}
+
+  ci-documentation-compliance:
+    runs-on: windows-2025-vs2026
+    timeout-minutes: 20
+    permissions:
+      contents: read
+      pull-requests: read
+      actions: write
+    steps:
+      - name: Run documentation compliance
+        uses: BHoM/CI_Toolkit/.github/actions/ci-compliance@develop
+        with:
+          check_type: documentation
+          patterns: '*.cs'
+          app_id: ${{ secrets.BHOM_APP_ID }}
+          private_key: ${{ secrets.BHOM_APP_PRIVATE_KEY }}
+
+  ci-project-compliance:
+    runs-on: windows-2025-vs2026
+    timeout-minutes: 20
+    permissions:
+      contents: read
+      pull-requests: read
+      actions: write
+    steps:
+      - name: Run project compliance
+        uses: BHoM/CI_Toolkit/.github/actions/ci-compliance@develop
+        with:
+          check_type: project
+          patterns: '*AssemblyInfo.cs *.csproj'
+          app_id: ${{ secrets.BHOM_APP_ID }}
+          private_key: ${{ secrets.BHOM_APP_PRIVATE_KEY }}
+
+  ci-dataset-tests:
+    runs-on: windows-2025-vs2026
+    timeout-minutes: 30
+    steps:
+      - name: Run dataset tests
+        uses: BHoM/CI_Toolkit/.github/actions/ci-dataset-tests@develop
+        with:
+          app_id: ${{ secrets.BHOM_APP_ID }}
+          private_key: ${{ secrets.BHOM_APP_PRIVATE_KEY }}
+
+  ci-serialisation:
+    runs-on: windows-2025-vs2026
+    timeout-minutes: 90
+    steps:
+      - name: Run serialisation
+        uses: BHoM/CI_Toolkit/.github/actions/ci-serialisation@develop
+        with:
+          app_id: ${{ secrets.BHOM_APP_ID }}
+          private_key: ${{ secrets.BHOM_APP_PRIVATE_KEY }}
+          base_ref: ${{ github.base_ref }}
+
+  ci-versioning:
+    runs-on: windows-2025-vs2026
+    timeout-minutes: 90
+    steps:
+      - name: Run versioning
+        uses: BHoM/CI_Toolkit/.github/actions/ci-versioning@develop
+        with:
+          app_id: ${{ secrets.BHOM_APP_ID }}
+          private_key: ${{ secrets.BHOM_APP_PRIVATE_KEY }}

Python_Engine/Compute/BasePythonEnvironment.cs

@@ -60,7 +60,11 @@ public static PythonEnvironment BasePythonEnvironment(
             bool exists = File.Exists(targetExecutable);
 
             if (exists && reload)
-                return new PythonEnvironment() { Name = Query.ToolkitName(), Executable = targetExecutable };
+            {
+                PythonEnvironment env = new PythonEnvironment() { Name = Query.ToolkitName(), Executable = targetExecutable };
+                UpdateBHoMPackages(env);
+                return env;
+            }
 
             if (exists && !reload)
                 // remove all existing environments and kernels

Python_Engine/Compute/UpdateBHoMPackages.cs

@@ -0,0 +1,110 @@
+/*
+ * This file is part of the Buildings and Habitats object Model (BHoM)
+ * Copyright (c) 2015 - 2026, the respective contributors. All rights reserved.
+ *
+ * Each contributor holds copyright over their respective contributions.
+ * The project versioning (Git) records all such contribution source information.
+ *                                           
+ *                                                                              
+ * The BHoM is free software: you can redistribute it and/or modify         
+ * it under the terms of the GNU Lesser General Public License as published by  
+ * the Free Software Foundation, either version 3.0 of the License, or          
+ * (at your option) any later version.                                          
+ *                                                                              
+ * The BHoM is distributed in the hope that it will be useful,              
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of               
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the                 
+ * GNU Lesser General Public License for more details.                          
+ *                                                                            
+ * You should have received a copy of the GNU Lesser General Public License     
+ * along with this code. If not, see <https://www.gnu.org/licenses/lgpl-3.0.html>.      
+ */
+
+using BH.oM.Base;
+using BH.oM.Base.Attributes;
+using BH.oM.Python;
+using BH.oM.Python.Enums;
+using System;
+using System.Collections.Generic;
+using System.ComponentModel;
+using System.Diagnostics;
+using System.IO;
+using System.Linq;
+using System.Text;
+
+namespace BH.Engine.Python
+{
+    public static partial class Compute
+    {
+        [Description("Using the environment name (and version if the environment name is the base python environment), directly install/update missing BHoM packages.")]
+        [Input("environmentName", "The name of the environment to update.")]
+        [Input("version", "If the environment name is the name of the base python environment, the version that needs updating.")]
+        public static void UpdateBHoMPackages(this string environmentName, PythonVersion version = PythonVersion.Undefined)
+        {
+            //construct the expected PythonEnvironment and pass to UpdateBHoMPackages
+            PythonEnvironment env = new PythonEnvironment()
+            {
+                Name = environmentName,
+            };
+
+            //python version is only used if the environment name is this toolkits name.
+            if (environmentName == Query.ToolkitName())
+            {
+                if (version == PythonVersion.Undefined)
+                {
+                    BH.Engine.Base.Compute.RecordError("The version must be specified when updating BHoM packages for a base python environment. No updates have occurred.");
+                    return;
+                }
+
+                env.Executable = Path.Combine(Query.DirectoryBaseEnvironment(version), "python.exe");
+            }
+            else
+                env.Executable = Query.VirtualEnvironmentExecutable(environmentName);
+
+            UpdateBHoMPackages(env);
+        }
+
+        /***************************************************/
+
+        [Description("Using a PythonEnvironment, directly install/update missing BHoM packages.")]
+        [Input("environment", "The python environment to update.")]
+        public static void UpdateBHoMPackages(this PythonEnvironment environment)
+        {
+            if (!File.Exists(environment.Executable))
+            {
+                BH.Engine.Base.Compute.RecordError($"Given environment or base install {environment.Executable} does not exist.");
+                return;
+            }
+
+            //`python -m pip list -e --format json` lists all environment packages that are editable installs.
+            //As all BHoM packages are editable installs, this handily lists all the packages that should be updated if necessary.
+            //side effect of updating other editable installs if they have changed, but I suspect this won't be a problem as anyone who has these would update packages manually instead.
+            System.Diagnostics.Process process = new System.Diagnostics.Process()
+            {
+                StartInfo = new System.Diagnostics.ProcessStartInfo()
+                {
+                    FileName = environment.Executable,
+                    Arguments = $"-m pip list -e --format json",
+                    UseShellExecute = false,
+                    RedirectStandardOutput = true,
+                }
+            };
+
+            process.StartInfo.Environment["PYTHONHOME"] = "";
+            string stdOut;
+
+            using (Process p = Process.Start(process.StartInfo))
+            {
+                stdOut = p.StandardOutput.ReadToEnd();
+                p.WaitForExit();
+            }
+
+            stdOut = stdOut.TrimEnd('\r', '\n');
+
+            IEnumerable<CustomObject> objs = Serialiser.Convert.FromJsonArray(stdOut).OfType<CustomObject>();
+
+            foreach (CustomObject obj in objs)
+                InstallPackageLocal(environment, (string)obj.CustomData["editable_project_location"]);
+        }
+    }
+}

Python_Engine/Compute/VirtualEnvironment.cs

@@ -60,7 +60,11 @@ public static PythonEnvironment VirtualEnvironment(this PythonVersion version, s
             bool exists = Query.VirtualEnvironmentExists(name);
 
             if (exists && reload)
-                return new PythonEnvironment() { Name = name, Executable = targetExecutable };
+            {
+                PythonEnvironment env = new PythonEnvironment() { Name = name, Executable = targetExecutable };
+                UpdateBHoMPackages(env);
+                return env;
+            }
 
             if (exists && !reload)
             {

Python_Engine/Python/Dockerfile

@@ -1,7 +1,22 @@
 FROM python:3.10-slim
-
 COPY . /Python_Toolkit
 
+#requires build argument --build-context bhom-assemblies C:/ProgramData/BHoM/Assemblies
+COPY --from=bhom-assemblies . /bin/BHoM/Assemblies
+
+#install .net core 8.0, and set the pythonnet runtime to the .net core CLR
+RUN apt-get update \
+	&& apt-get install -y wget
+
+RUN wget https://packages.microsoft.com/config/debian/13/packages-microsoft-prod.deb -O packages-microsoft-prod.deb
+RUN dpkg -i packages-microsoft-prod.deb
+RUN rm packages-microsoft-prod.deb
+
+RUN apt-get update \
+	&& apt-get install -y aspnetcore-runtime-10.0
+
+ENV PYTHONNET_RUNTIME="coreclr"
+
 RUN pip3 install ./Python_Toolkit
 
 RUN rm ./Python_Toolkit -rf

Python_Engine/Python/pyproject.toml

@@ -16,6 +16,7 @@ dependencies = [
     "pytest-cov>=6.0.0",
     "pytest-order",
     "virtualenv",
+    "pythonnet",
 ]
 
 [urls]

Python_Engine/Python/src/python_toolkit/bhom/__init__.py

@@ -6,9 +6,15 @@
 import tempfile
 import importlib.metadata
 
+if os.name == 'nt':
+    from .installer_info import INSTALLER_INFO
+else:
+    INSTALLER_INFO = {"Version": importlib.metadata.version("python_toolkit")}
+
 BHOM_LOG_FOLDER = Path(path.expandvars("%PROGRAMDATA%/BHoM/Logs"))
+TEMP_LOG_FOLDER = Path(tempfile.gettempdir()) / "BHoM" / "Logs"
 TOOLKIT_NAME = "Python_Toolkit"
-BHOM_VERSION = importlib.metadata.version("python_toolkit")
+BHOM_VERSION = INSTALLER_INFO["Version"]
 
 #Environment variable that if set disables BHoM analytics logging.
 DISABLE_ANALYTICS = os.environ.get("DISABLE_BHOM_ANALYTICS", None)
@@ -18,5 +24,18 @@
     DISABLE_ANALYTICS = True
 
 if not BHOM_LOG_FOLDER.exists():
-    BHOM_LOG_FOLDER = Path(tempfile.gettempdir()) / "BHoM" / "Logs"
-    BHOM_LOG_FOLDER.mkdir(exist_ok=True, parents=True)
+
+    try:
+        BHOM_LOG_FOLDER.mkdir(exist_ok=True, parents=True)
+
+        #migration recovery for any logs in the temp folder
+        if TEMP_LOG_FOLDER.exists():
+            for file in TEMP_LOG_FOLDER.glob("*.log"):
+                file.rename(BHOM_LOG_FOLDER / file.name)
+
+    except Exception as e:
+        BHOM_LOG_FOLDER = TEMP_LOG_FOLDER
+        BHOM_LOG_FOLDER.mkdir(exist_ok=True, parents=True)
+
+
+

Python_Engine/Python/src/python_toolkit/bhom/analytics.py

@@ -71,6 +71,8 @@ def summarise_usage_logs(usage_log_entries:List[UsageLogEntry]) -> List[Dict]:
 
     usage_log_entries.sort(key=lambda x: x.ProjectID)
 
+    short_bhom_version = ".".join(BHOM_VERSION.split(".", 2)[0:2])
+
     for file_id, filegroup in groupby(usage_log_entries, lambda x: x.FileId):
         filegroup = list(filegroup)
         project_id = filegroup[0].ProjectID
@@ -89,15 +91,17 @@ def summarise_usage_logs(usage_log_entries:List[UsageLogEntry]) -> List[Dict]:
                 "CallerName": first_entry.CallerName,
                 "SelectedItem": first_entry.SelectedItem,
                 "Computer": socket.gethostname(),
-                "UserName": os.environ.get("USERNAME"),
-                "BHoMVersion": BHOM_VERSION,
+                "Username": os.environ.get("USERNAME"),
+                "BHoMVersion": short_bhom_version,
                 "FileId": file_id,
                 "FileName": filename,
                 "ProjectID": project_id,
                 "NbCallingComponents": len(set([a.ComponentId for a in methodgroup])),
-                "TotalNbCals": len(methodgroup),
+                "TotalNbCalls": len(methodgroup),
                 "Errors": list(itertools.chain.from_iterable([x.Errors for x in methodgroup])),
-                "_t": "BH.oM.BHoMAnalytics.UsageEntry"
+                "_t": "BH.oM.BHoMAnalytics.UsageEntry",
+                "__Time__": datetime.now(),
+                "_bhomVersion": short_bhom_version
             })
 
     return db_entries
@@ -150,7 +154,7 @@ def decorator(function: Callable):
         @wraps(function)
         def wrapper(*args, **kwargs) -> Any:
             """A wrapper around the function that captures usage analytics."""
-
+                
             if disable:
                 CONSOLE_LOGGER.debug("bhom_analytics is curently disabled.")
                 return function(*args, **kwargs)