7.1 Deployment

LadybugTools_Adapter/AdapterActions/Execute.cs

@@ -1,6 +1,6 @@
 /*
  * This file is part of the Buildings and Habitats object Model (BHoM)
- * Copyright (c) 2015 - 2023, the respective contributors. All rights reserved.
+ * Copyright (c) 2015 - 2024, the respective contributors. All rights reserved.
  *
  * Each contributor holds copyright over their respective contributions.
  * The project versioning (Git) records all such contribution source information.
@@ -34,6 +34,11 @@
 using System.IO;
 using System.Linq;
 using System.Text;
+using BH.Engine.Base;
+using System.Drawing;
+using BH.Engine.Serialiser;
+using BH.Engine.LadyBugTools;
+using System.Reflection;
 
 namespace BH.Adapter.LadybugTools
 {
@@ -74,7 +79,6 @@ public List<object> IRunCommand(IExecuteCommand command)
 
         private List<object> RunCommand(GetMaterialCommand command)
         {
-            PythonEnvironment env = Engine.LadybugTools.Compute.InstallPythonEnv_LBT(true);
             LadybugConfig config = new LadybugConfig()
             {
                 JsonFile = new FileSettings()
@@ -88,7 +92,7 @@ private List<object> RunCommand(GetMaterialCommand command)
             {
                 string script = Path.Combine(Engine.Python.Query.DirectoryCode(), "LadybugTools_Toolkit\\src\\ladybugtools_toolkit\\bhom\\wrapped", "get_material.py");
 
-                string cmdCommand = $"{env.Executable} {script} -j \"{config.JsonFile.GetFullFileName()}\"";
+                string cmdCommand = $"{m_environment.Executable} {script} -j \"{config.JsonFile.GetFullFileName()}\"";
 
                 Engine.Python.Compute.RunCommandStdout(command: cmdCommand, hideWindows: true);
             }
@@ -103,7 +107,6 @@ private List<object> RunCommand(GetMaterialCommand command)
 
         private List<object> RunCommand(GetTypologyCommand command)
         {
-            PythonEnvironment env = Engine.LadybugTools.Compute.InstallPythonEnv_LBT(true);
             LadybugConfig config = new LadybugConfig()
             {
                 JsonFile = new FileSettings()
@@ -117,7 +120,7 @@ private List<object> RunCommand(GetTypologyCommand command)
             {
                 string script = Path.Combine(Engine.Python.Query.DirectoryCode(), "LadybugTools_Toolkit\\src\\ladybugtools_toolkit\\bhom\\wrapped", "get_typology.py");
 
-                string cmdCommand = $"{env.Executable} {script} -j \"{config.JsonFile.GetFullFileName()}\"";
+                string cmdCommand = $"{m_environment.Executable} {script} -j \"{config.JsonFile.GetFullFileName()}\"";
 
                 Engine.Python.Compute.RunCommandStdout(command: cmdCommand, hideWindows: true);
             }
@@ -133,15 +136,15 @@ private List<object> RunCommand(GetTypologyCommand command)
         private List<object> RunCommand(RunSimulationCommand command)
         {
             // validation prior to passing to Python
-            if (command.EpwFile == null)
+            if (command.EPWFile == null)
             {
-                BH.Engine.Base.Compute.RecordError($"{nameof(command.EpwFile)} input cannot be null.");
+                BH.Engine.Base.Compute.RecordError($"{nameof(command.EPWFile)} input cannot be null.");
                 return null;
             }
 
-            if (!File.Exists(command.EpwFile.GetFullFileName()))
+            if (!File.Exists(command.EPWFile.GetFullFileName()))
             {
-                BH.Engine.Base.Compute.RecordError($"{command.EpwFile.GetFullFileName()} does not exist.");
+                BH.Engine.Base.Compute.RecordError($"FIle '{command.EPWFile.GetFullFileName()}' does not exist.");
                 return null;
             }
 
@@ -170,21 +173,20 @@ private List<object> RunCommand(RunSimulationCommand command)
             // construct the base object and file to be passed to Python for simulation
             SimulationResult simulationResult = new SimulationResult()
             {
-                EpwFile = Path.GetFullPath(command.EpwFile.GetFullFileName()).Replace(@"\", "/"),
+                EpwFile = Path.GetFullPath(command.EPWFile.GetFullFileName()).Replace(@"\", "/"),
                 GroundMaterial = command.GroundMaterial,
                 ShadeMaterial = command.ShadeMaterial,
-                Name = Engine.LadybugTools.Compute.SimulationID(command.EpwFile.GetFullFileName(), command.GroundMaterial, command.ShadeMaterial)
+                Name = Engine.LadybugTools.Compute.SimulationID(command.EPWFile.GetFullFileName(), command.GroundMaterial, command.ShadeMaterial)
             };
 
             // push object to json file
             Push(new List<SimulationResult>() { simulationResult }, actionConfig: config);
 
-            // locate the Python executable and file containing the simulation code
-            PythonEnvironment env = Engine.LadybugTools.Compute.InstallPythonEnv_LBT(true);
+            // locate the Python file containing the simulation code
             string script = Path.Combine(Engine.Python.Query.DirectoryCode(), "LadybugTools_Toolkit\\src\\ladybugtools_toolkit\\bhom\\wrapped", "simulation_result.py");
 
             // run the simulation
-            string cmdCommand = $"{env.Executable} {script} -j \"{config.JsonFile.GetFullFileName()}\"";
+            string cmdCommand = $"{m_environment.Executable} {script} -j \"{config.JsonFile.GetFullFileName()}\"";
             Engine.Python.Compute.RunCommandStdout(command: cmdCommand, hideWindows: true);
 
             // reload from Python results
@@ -232,12 +234,11 @@ private List<object> RunCommand(RunExternalComfortCommand command)
             // push objects to json file
             Push(new List<ExternalComfort>() { externalComfort }, actionConfig: config);
 
-            // locate the Python executable and file containing the simulation code
-            PythonEnvironment env = Engine.LadybugTools.Compute.InstallPythonEnv_LBT(true);
+            // locate the Python file containing the simulation code
             string script = Path.Combine(Engine.Python.Query.DirectoryCode(), "LadybugTools_Toolkit\\src\\ladybugtools_toolkit\\bhom\\wrapped", "external_comfort.py");
 
             // run the calculation
-            string cmdCommand = $"{env.Executable} {script} -j \"{config.JsonFile.GetFullFileName()}\"";
+            string cmdCommand = $"{m_environment.Executable} {script} -j \"{config.JsonFile.GetFullFileName()}\"";
             Engine.Python.Compute.RunCommandStdout(command: cmdCommand, hideWindows: true);
 
             // reload from Python results
@@ -250,6 +251,157 @@ private List<object> RunCommand(RunExternalComfortCommand command)
             return externalComfortPopulated;
         }
 
+        /**************************************************/
+
+        private List<object> RunCommand(HeatPlotCommand command)
+        {
+            if (command.EPWFile == null)
+            {
+                BH.Engine.Base.Compute.RecordError($"{nameof(command.EPWFile)} input cannot be null.");
+                return null;
+            }
+
+            if (!System.IO.File.Exists(command.EPWFile.GetFullFileName()))
+            {
+                BH.Engine.Base.Compute.RecordError($"File '{command.EPWFile}' does not exist.");
+                return null;
+            }
+
+            string epwFile = System.IO.Path.GetFullPath(command.EPWFile.GetFullFileName());
+
+            string script = Path.Combine(Engine.Python.Query.DirectoryCode(), "LadybugTools_Toolkit\\src\\ladybugtools_toolkit\\bhom\\wrapped\\plot", "heatmap.py");
+
+            //check if the colourmap is valid for user warning, but run with input anyway as the map could be defined separately.
+            string colourMap = command.ColourMap;
+            if (colourMap.ColourMapValidity())
+                colourMap = colourMap.ToColourMap().FromColourMap();
+
+            // run the process
+            string cmdCommand = $"{m_environment.Executable} {script} -e \"{epwFile}\" -dtk \"{command.EPWKey.ToText()}\" -cmap \"{colourMap}\" -p \"{command.OutputLocation}\"";
+            string result = Engine.Python.Compute.RunCommandStdout(command: cmdCommand, hideWindows: true);
+
+            m_executeSuccess = true;
+            return new List<object>() { result };
+        }
+
+        /**************************************************/
+
+        private List<object> RunCommand(WindroseCommand command)
+        {
+            if (command.EPWFile == null)
+            {
+                BH.Engine.Base.Compute.RecordError($"{nameof(command.EPWFile)} input cannot be null.");
+                return null;
+            }
+
+            if (!System.IO.File.Exists(command.EPWFile.GetFullFileName()))
+            {
+                BH.Engine.Base.Compute.RecordError($"File '{command.EPWFile.GetFullFileName()}' does not exist.");
+                return null;
+            }
+
+            if (command.AnalysisPeriod == null)
+            {
+                BH.Engine.Base.Compute.RecordError($"Please input a valid analysis period to run this command.");
+                return null;
+            }
+
+            string epwFile = System.IO.Path.GetFullPath(command.EPWFile.GetFullFileName());
+
+            string script = Path.Combine(Engine.Python.Query.DirectoryCode(), "LadybugTools_Toolkit\\src\\ladybugtools_toolkit\\bhom\\wrapped\\plot", "windrose.py");
+
+            //check if the colourmap is valid for user warning, but run with input anyway as the map could be defined separately.
+            string colourMap = command.ColourMap;
+            if (colourMap.ColourMapValidity())
+                colourMap = colourMap.ToColourMap().FromColourMap();
+
+            // run the process
+            string cmdCommand = $"{m_environment.Executable} {script} -e \"{epwFile}\" -ap \"{command.AnalysisPeriod.FromBHoM().Replace("\"", "\\\"")}\" -cmap \"{colourMap}\" -bins \"{command.NumberOfDirectionBins}\" -p \"{command.OutputLocation}\"";
+            string result = Engine.Python.Compute.RunCommandStdout(command: cmdCommand, hideWindows: true);
+
+            m_executeSuccess = true;
+            return new List<object> { result };
+        }
+
+        /**************************************************/
+
+        private List<object> RunCommand(UTCIHeatPlotCommand command)
+        {
+            if (command.EPWFile == null)
+            {
+                BH.Engine.Base.Compute.RecordError($"{nameof(command.EPWFile)} input cannot be null.");
+                return null;
+            }
+
+            if (!System.IO.File.Exists(command.EPWFile.GetFullFileName()))
+            {
+                BH.Engine.Base.Compute.RecordError($"File '{command.EPWFile.GetFullFileName()}' does not exist.");
+                return null;
+            }
+
+            if (command.GroundMaterial == null)
+            {
+                BH.Engine.Base.Compute.RecordError($"Please input a valid ground material to run this command.");
+                return null;
+            }
+
+            if (command.ShadeMaterial == null)
+            {
+                BH.Engine.Base.Compute.RecordError($"Please input a valid shade material to run this command.");
+                return null;
+            }
+
+            if (command.Typology == null)
+            {
+                BH.Engine.Base.Compute.RecordError($"Please input a valid Typology to run this command.");
+            }
+
+            if (!(command.BinColours.Count == 10 || command.BinColours.Count == 0))
+            {
+                BH.Engine.Base.Compute.RecordError($"When overriding bin colours 10 colours must be provided, but {command.BinColours.Count} colours were provided instead.");
+                return null;
+            }
+            List<string> colours = command.BinColours.Select(x => x.ToHexCode()).ToList();
+
+            string hexColours = $"[\"{string.Join("\",\"", colours)}\"]";
+            if (hexColours == "[\"\"]")
+                hexColours = "[]";
+
+            Dictionary<string, string> inputObjects = new Dictionary<string, string>()
+            {
+                { "ground_material",  command.GroundMaterial.FromBHoM() },
+                { "shade_material", command.ShadeMaterial.FromBHoM() },
+                { "typology", command.Typology.FromBHoM() },
+                { "bin_colours", hexColours }
+            };
+
+            string argFile = Path.GetTempFileName();
+            File.WriteAllText(argFile, inputObjects.ToJson());
+
+            string epwFile = System.IO.Path.GetFullPath(command.EPWFile.GetFullFileName());
+
+            string script = Path.Combine(Engine.Python.Query.DirectoryCode(), "LadybugTools_Toolkit\\src\\ladybugtools_toolkit\\bhom\\wrapped\\plot", "utci_heatmap.py");
+
+            // run the process
+            string cmdCommand = $"{m_environment.Executable} \"{script}\" -e \"{epwFile}\" -in \"{argFile}\" -ws \"{command.WindSpeedMultiplier}\" -sp \"{command.OutputLocation}\"";
+            string result = "";
+
+            try
+            {
+                result = Engine.Python.Compute.RunCommandStdout(command: cmdCommand, hideWindows: true);
+            }
+            catch (Exception ex)
+            {
+                BH.Engine.Base.Compute.RecordError(ex, "An error occurred while running some python.");
+            }
+            finally
+            {
+                File.Delete(argFile);
+            }
+
+            return new List<object> { result.Split('\n').Last() };
+        }
+
         /**************************************************/
         /* Private methods - Fallback                     */
         /**************************************************/
@@ -261,3 +413,4 @@ private List<object> RunCommand(IExecuteCommand command)
         }
     }
 }
+

LadybugTools_Adapter/AdapterActions/Pull.cs

@@ -1,6 +1,6 @@
 /*
  * This file is part of the Buildings and Habitats object Model (BHoM)
- * Copyright (c) 2015 - 2023, the respective contributors. All rights reserved.
+ * Copyright (c) 2015 - 2024, the respective contributors. All rights reserved.
  *
  * Each contributor holds copyright over their respective contributions.
  * The project versioning (Git) records all such contribution source information.
@@ -70,3 +70,4 @@ public override IEnumerable<object> Pull(IRequest request, PullType pullType = P
         }
     }
 }
+

LadybugTools_Adapter/AdapterActions/Push.cs

@@ -1,6 +1,6 @@
 /*
  * This file is part of the Buildings and Habitats object Model (BHoM)
- * Copyright (c) 2015 - 2023, the respective contributors. All rights reserved.
+ * Copyright (c) 2015 - 2024, the respective contributors. All rights reserved.
  *
  * Each contributor holds copyright over their respective contributions.
  * The project versioning (Git) records all such contribution source information.
@@ -68,3 +68,4 @@ public override List<object> Push(IEnumerable<object> objects, string tag = "",
         }
     }
 }
+

LadybugTools_Adapter/CRUD/CreateLadybug.cs

@@ -1,6 +1,6 @@
 /*
  * This file is part of the Buildings and Habitats object Model (BHoM)
- * Copyright (c) 2015 - 2023, the respective contributors. All rights reserved.
+ * Copyright (c) 2015 - 2024, the respective contributors. All rights reserved.
  *
  * Each contributor holds copyright over their respective contributions.
  * The project versioning (Git) records all such contribution source information.
@@ -51,3 +51,4 @@ public static void CreateLadybug(List<ILadybugTools> objects, LadybugConfig conf
         }
     }
 }
+

LadybugTools_Adapter/CRUD/Read.cs

@@ -1,6 +1,6 @@
 /*
  * This file is part of the Buildings and Habitats object Model (BHoM)
- * Copyright (c) 2015 - 2023, the respective contributors. All rights reserved.
+ * Copyright (c) 2015 - 2024, the respective contributors. All rights reserved.
  *
  * Each contributor holds copyright over their respective contributions.
  * The project versioning (Git) records all such contribution source information.
@@ -41,3 +41,4 @@ protected override IEnumerable<IBHoMObject> IRead(Type type, IList indices = nul
         }
     }
 }
+

LadybugTools_Adapter/Convert/Collections/EPW.cs

@@ -1,6 +1,6 @@
 /*
  * This file is part of the Buildings and Habitats object Model (BHoM)
- * Copyright (c) 2015 - 2023, the respective contributors. All rights reserved.
+ * Copyright (c) 2015 - 2024, the respective contributors. All rights reserved.
  *
  * Each contributor holds copyright over their respective contributions.
  * The project versioning (Git) records all such contribution source information.
@@ -38,10 +38,10 @@
             Location location = new Location();
             Dictionary<string, object> metaData = new Dictionary<string, object>();
 
             try
             {
                 if (oldObject["location"].GetType() == typeof(CustomObject))
                     oldObject["location"] = (oldObject["location"] as CustomObject).CustomData;
                 location = ToLocation(oldObject["location"] as Dictionary<string, object>);
             }
             catch (Exception ex)
@@ -49,10 +49,10 @@
                 BH.Engine.Base.Compute.RecordError($"An error occurred when reading the Location of the EPW. returning a default Location.\n The error: {ex}");
             }
 
             try
             {
                 if (oldObject["metadata"].GetType() == typeof(CustomObject))
                     oldObject["metadata"] = (oldObject["metadata"] as CustomObject).CustomData;
                 metaData = (Dictionary<string, object>)oldObject["metadata"];
             }
             catch (Exception ex)
@@ -62,14 +62,14 @@
 
             List<BH.oM.LadybugTools.HourlyContinuousCollection> collections = new List<BH.oM.LadybugTools.HourlyContinuousCollection>();
 
             if (oldObject.ContainsKey("data_collections"))
             {
                 foreach (var collection in oldObject["data_collections"] as List<object>)
                 {
                     if (collection.GetType() == typeof(CustomObject))
                         collections.Add(ToHourlyContinuousCollection((collection as CustomObject).CustomData));
                     else
                         collections.Add(ToHourlyContinuousCollection(collection as Dictionary<string, object>));
                 }
             }
             else
@@ -102,3 +102,4 @@
         }
     }
 }
+

LadybugTools_Adapter/Convert/Collections/HourlyContinuousCollection.cs

@@ -1,6 +1,6 @@
 /*
  * This file is part of the Buildings and Habitats object Model (BHoM)
- * Copyright (c) 2015 - 2023, the respective contributors. All rights reserved.
+ * Copyright (c) 2015 - 2024, the respective contributors. All rights reserved.
  *
  * Each contributor holds copyright over their respective contributions.
  * The project versioning (Git) records all such contribution source information.
@@ -37,10 +37,10 @@
         {
             Header header = new Header();
             List<string> hourlyValues = new List<string>();
             try
             {
                 if (oldObject["header"].GetType() == typeof(CustomObject))
                     oldObject["header"] = (oldObject["header"] as CustomObject).CustomData;
                 header = ToHeader(oldObject["header"] as Dictionary<string, object>);
             }
             catch (Exception ex)
@@ -80,3 +80,4 @@
         }
     }
 }
+

LadybugTools_Adapter/Convert/Constructions/EnergyMaterial.cs

@@ -1,6 +1,6 @@
 /*
  * This file is part of the Buildings and Habitats object Model (BHoM)
- * Copyright (c) 2015 - 2023, the respective contributors. All rights reserved.
+ * Copyright (c) 2015 - 2024, the respective contributors. All rights reserved.
  *
  * Each contributor holds copyright over their respective contributions.
  * The project versioning (Git) records all such contribution source information.
@@ -150,3 +150,4 @@ public static Dictionary<string, object> FromEnergyMaterial(BH.oM.LadybugTools.E
         }
     }
 }
+

LadybugTools_Adapter/Convert/Constructions/EnergyMaterialVegetation.cs

@@ -1,6 +1,6 @@
 /*
  * This file is part of the Buildings and Habitats object Model (BHoM)
- * Copyright (c) 2015 - 2023, the respective contributors. All rights reserved.
+ * Copyright (c) 2015 - 2024, the respective contributors. All rights reserved.
  *
  * Each contributor holds copyright over their respective contributions.
  * The project versioning (Git) records all such contribution source information.
@@ -219,3 +219,4 @@ public static Dictionary<string, object> FromEnergyMaterialVegetation(BH.oM.Lady
         }
     }
 }
+

LadybugTools_Adapter/Convert/FromBHoM.cs

@@ -1,6 +1,6 @@
 /*
  * This file is part of the Buildings and Habitats object Model (BHoM)
- * Copyright (c) 2015 - 2023, the respective contributors. All rights reserved.
+ * Copyright (c) 2015 - 2024, the respective contributors. All rights reserved.
  *
  * Each contributor holds copyright over their respective contributions.
  * The project versioning (Git) records all such contribution source information.
@@ -109,3 +109,4 @@ private static Dictionary<string, object> Jsonify(this ILadybugTools obj)
         }
     }
 }
+