Migrate openfield methods and update versions

LadybugTools_Engine/Compute/ExternalComfort.cs

@@ -0,0 +1,100 @@
+/*
+ * This file is part of the Buildings and Habitats object Model (BHoM)
+ * Copyright (c) 2015 - 2022, 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.Engine.Python;
+using BH.oM.Ladybug;
+using BH.oM.Python;
+using BH.oM.Base.Attributes;
+using System;
+using System.Collections.Generic;
+using System.ComponentModel;
+using System.Linq;
+using BH.oM.Base;
+using System.IO;
+
+namespace BH.Engine.LadybugTools
+{
+    public static partial class Compute
+    {
+        [Description("Run an External Comfort simulation and return results.")]
+        [Input("epw", "An EPW file.")]
+        [Input("groundMaterial", "A pre-defined ground material.")]
+        [Input("shadeMaterial", "A pre-defined shade material.")]
+        [Output("externalComfortResult", "An external comfort result object containing simulation results.")]
+        public static CustomObject ExternalComfort(string epw, ExternalComfortMaterial groundMaterial, ExternalComfortMaterial shadeMaterial)
+        {
+            PythonEnvironment pythonEnvironment = Python.Query.LoadPythonEnvironment(Query.ToolkitName());
+            if (!pythonEnvironment.IsInstalled())
+            {
+                BH.Engine.Base.Compute.RecordError($"Install the {Query.ToolkitName()} Python environment before running this method (using {Query.ToolkitName()}.Compute.InstallPythonEnvironment).");
+                return null;
+            }
+
+            if (!ExternalComfortPossible())
+                return null;
+
+            if (groundMaterial == ExternalComfortMaterial.Undefined || shadeMaterial == ExternalComfortMaterial.Undefined)
+            {
+                BH.Engine.Base.Compute.RecordError($"Please input a valid ExternalComfortMaterial.");
+                return null;
+            }
+
+            if (!File.Exists(epw))
+            {
+                BH.Engine.Base.Compute.RecordError($"The EPW file given cannot be found.");
+                return null;
+            }
+
+            string outputPath = Path.Combine(Path.GetTempPath(), $"{System.Guid.NewGuid()}.json");
+
+            string epwPath = Path.GetFullPath(epw);
+
+            string pythonScript = String.Join("\n", new List<string>() 
+            {
+                "import sys",
+                $"sys.path.insert(0, '{pythonEnvironment.CodeDirectory()}')",
+                "",
+                "from ladybug.epw import EPW",
+                "from external_comfort.external_comfort import ExternalComfort, ExternalComfortResult",
+                "from external_comfort.material import Material",
+                "",
+                $"epw = EPW(r'{epwPath}')",
+                $"ec = ExternalComfort(epw, ground_material=Material.{groundMaterial}.value, shade_material=Material.{shadeMaterial}.value)",
+                "ecr = ExternalComfortResult(ec)",
+                $"ecr.to_json(r'{outputPath}')",
+                "print('Nothing to see here!')",
+            });
+
+            string output = Python.Compute.RunPythonString(pythonEnvironment, pythonScript).Trim();
+
+            string jsonString = "";
+            using (StreamReader r = new StreamReader(outputPath))
+            {
+                jsonString = r.ReadToEnd();
+            }
+
+
+            return Serialiser.Convert.FromJson(jsonString) as CustomObject;
+        }
+    }
+}
+

LadybugTools_Engine/Compute/ExternalComfortPossible.cs

@@ -0,0 +1,66 @@
+/*
+ * This file is part of the Buildings and Habitats object Model (BHoM)
+ * Copyright (c) 2015 - 2022, 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.Attributes;
+using System.Collections.Generic;
+using System.IO;
+using System.ComponentModel;
+
+namespace BH.Engine.LadybugTools
+{
+    public static partial class Compute
+    {
+        [Description("Determine whether the External Comfort process is possible.")]
+        [Output("bool", "True if External Comfort simulation is possible.")]
+        public static bool ExternalComfortPossible()
+        {
+            string username = System.Environment.UserName;
+
+            string ladybugToolsFolder = $"C:/Users/{username}/ladybug_tools";
+            string defaultSimulationFolder = $"C:/Users/{username}/simulation";
+
+            string openstudioPath = System.IO.Path.Combine(ladybugToolsFolder, "openstudio/bin");
+            string energyplusPath = System.IO.Path.Combine(ladybugToolsFolder, "openstudio/EnergyPlus");
+            string honeybeeOpenstudioGemPath = System.IO.Path.Combine(ladybugToolsFolder, "resources/measures/honeybee_openstudio_gem/lib");
+            string radiancePath = System.IO.Path.Combine(ladybugToolsFolder, "radiance");
+
+            foreach (string path in new List<string>() {
+                ladybugToolsFolder,
+                defaultSimulationFolder,
+                openstudioPath,
+                energyplusPath,
+                honeybeeOpenstudioGemPath,
+                radiancePath,
+            })
+            {
+                if (!Directory.Exists(path))
+                {
+                    BH.Engine.Base.Compute.RecordError($"Install Ladybug Tools using the instructions found https://www.food4rhino.com/en/app/ladybug-tools in order to be able to run this method.");
+                    return false;
+                }
+            }
+
+            return true;
+        }
+    }
+}
+

LadybugTools_Engine/Compute/ExternalComfortTypology.cs

@@ -0,0 +1,110 @@
+/*
+ * This file is part of the Buildings and Habitats object Model (BHoM)
+ * Copyright (c) 2015 - 2022, 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.Engine.Python;
+using BH.oM.Ladybug;
+using BH.oM.Python;
+using BH.oM.Base.Attributes;
+using System;
+using System.Collections.Generic;
+using System.ComponentModel;
+using System.Linq;
+using BH.oM.Base;
+using System.IO;
+
+namespace BH.Engine.LadybugTools
+{
+    public static partial class Compute
+    {
+        [Description("Run an External Comfort simulation and return results.")]
+        [Input("epw", "An EPW file.")]
+        [Input("groundMaterial", "A pre-defined ground material.")]
+        [Input("shadeMaterial", "A pre-defined shade material.")]
+        [Input("typology", "A pre-defined external comfort typology.")]
+        [Output("typologyResult", "A typology result object containing simulation results and typology specific comfort metrics.")]
+        public static CustomObject ExternalComfortTypology(string epw, ExternalComfortMaterial groundMaterial, ExternalComfortMaterial shadeMaterial, BH.oM.Ladybug.ExternalComfortTypology typology)
+        {
+            PythonEnvironment pythonEnvironment = Python.Query.LoadPythonEnvironment(Query.ToolkitName());
+            if (!pythonEnvironment.IsInstalled())
+            {
+                BH.Engine.Base.Compute.RecordError($"Install the {Query.ToolkitName()} Python environment before running this method (using {Query.ToolkitName()}.Compute.InstallPythonEnvironment).");
+                return null;
+            }
+
+            if (!ExternalComfortPossible())
+                return null;
+
+            if (groundMaterial == ExternalComfortMaterial.Undefined || shadeMaterial == ExternalComfortMaterial.Undefined)
+            {
+                BH.Engine.Base.Compute.RecordError($"Please input a valid ExternalComfortMaterial.");
+                return null;
+            }
+
+            if (typology == BH.oM.Ladybug.ExternalComfortTypology.Undefined)
+            {
+                BH.Engine.Base.Compute.RecordError($"Please input a valid ExternalComfortTypology.");
+                return null;
+            }
+
+            if (!File.Exists(epw))
+            {
+                BH.Engine.Base.Compute.RecordError($"The EPW file given cannot be found.");
+                return null;
+            }
+
+            string epwPath = Path.GetFullPath(epw);
+
+            string outputPath = Path.Combine(Path.GetTempPath(), $"{System.Guid.NewGuid()}.json");
+
+            string pythonScript = String.Join("\n", new List<string>() 
+            {
+                "import sys",
+                $"sys.path.insert(0, '{pythonEnvironment.CodeDirectory()}')",
+                "",
+                "from ladybug.epw import EPW",
+                "from external_comfort.external_comfort import ExternalComfort, ExternalComfortResult",
+                "from external_comfort.material import Material",
+                "from external_comfort.typology import Typologies, TypologyResult",
+                "",
+                $"epw = EPW(r'{epwPath}')",
+                $"ec = ExternalComfort(epw, ground_material=Material.{groundMaterial}.value, shade_material=Material.{shadeMaterial}.value)",
+                "ecr = ExternalComfortResult(ec)",
+                $"typ = Typologies.{typology}.value",
+                "typr = TypologyResult(typ, ecr)",
+                $"typr.to_json(r'{outputPath}')",
+                "print('Nothing to see here!')",
+            });
+
+            string output = Python.Compute.RunPythonString(pythonEnvironment, pythonScript).Trim();
+
+            string jsonString = "";
+            using (StreamReader r = new StreamReader(outputPath))
+            {
+                jsonString = r.ReadToEnd();
+            }
+
+
+            return Serialiser.Convert.FromJson(jsonString) as CustomObject;
+        }
+    }
+}
+

LadybugTools_Engine/Compute/InstallLadybugToolsPythonEnvironment.cs

@@ -21,11 +21,10 @@
  */
 
 using System.ComponentModel;
+using System.IO;
 
-using BH.Engine.Python;
 using BH.oM.Python;
 using BH.oM.Base.Attributes;
-using System.IO;
 
 namespace BH.Engine.LadybugTools
 {
@@ -37,6 +36,20 @@ public static partial class Compute
         [Output("pythonEnvironment", "The LadybugTools_Toolkit Python environment.")]
         public static PythonEnvironment InstallLadybugToolsPythonEnvironment(bool run = false, bool force = false)
         {
+            string ladybugToolsDirectory = Path.Combine(System.Environment.GetFolderPath(System.Environment.SpecialFolder.UserProfile), "ladybug_tools");
+
+            if (!Directory.Exists(ladybugToolsDirectory))
+                BH.Engine.Base.Compute.RecordWarning($"It looks like ladybug_tools are not installed on this machine. Code functionality for Radiance and EnergyPlus simulation will not work without a full installation. Follow instructions https://github.com/ladybug-tools/lbt-grasshopper/wiki/1.1-Windows-Installation-Steps#optional-steps to install it for the latest version of ladybug_tools.");
+
+            if (!Directory.Exists(Path.Combine(ladybugToolsDirectory, "openstudio")))
+                BH.Engine.Base.Compute.RecordWarning($"Openstudio is not installed in {Path.Combine(ladybugToolsDirectory, "openstudio")} and any commands used that call to it will not work. Follow instructions https://github.com/ladybug-tools/lbt-grasshopper/wiki/1.1-Windows-Installation-Steps#optional-steps to install it for the latest version of ladybug_tools.");
+
+            if (!Directory.Exists(Path.Combine(ladybugToolsDirectory, "radiance")))
+                BH.Engine.Base.Compute.RecordWarning($"Radiance is not installed in {Path.Combine(ladybugToolsDirectory, "radiance")} and any commands used that call to it will not work. Follow instructions https://github.com/ladybug-tools/lbt-grasshopper/wiki/1.1-Windows-Installation-Steps#optional-steps to install it for the latest version of ladybug_tools.");
+
+            if (!Directory.Exists(Path.Combine(ladybugToolsDirectory, "resources", "measures", "honeybee_openstudio_gem")))
+                BH.Engine.Base.Compute.RecordWarning($"honeybee-openstudio-gem measures are not available in {Path.Combine(ladybugToolsDirectory, "resources", "measures", "honeybee_openstudio_gem")} and any commands used that call to them will not work. Follow instructions https://github.com/ladybug-tools/lbt-grasshopper/wiki/1.1-Windows-Installation-Steps to install this for the latest version of ladybug_tools.");
+
             // The following checks for beta 5.1 only. These json files to be added to the installer for later versions. 
             if (!File.Exists(@"C:\ProgramData\BHoM\Settings\Python\LadybugTools_Toolkit.json"))
                 Base.Compute.RecordError("LadybugTools_Toolkit.json does not exist. Visit the following page for more information: https://github.com/BHoM/LadybugTools_Toolkit/wiki/Beta-version-5.1---Installation-instructions");