Add multitude of features to the toolkit

.gitignore

@@ -211,3 +211,8 @@ cython_debug/
 # Testing files
 *.ipynb
 .dev/
+prototypes/
+build.ps1
+
+# unignored files
+!example.sql

LadybugTools_Engine/Compute/EPWtoCSV.cs

@@ -4,26 +4,26 @@
  *
  * 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>.      
+ *
+ *
+ * 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.Python;
 using BH.oM.Base.Attributes;
 
-using System;
 using System.Collections.Generic;
 using System.ComponentModel;
 
@@ -33,8 +33,10 @@ public static partial class Compute
     {
         [Description("Convert an EPW file into a CSV and return the path to that CSV.")]
         [Input("epwFile", "An EPW file.")]
+        [Input("includeAdditional", "Add sun position and psychrometric properties to the resultant CSV.")]
         [Output("csv", "The generated CSV file.")]
-        public static string EPWtoCSV(string epwFile)
+        [PreviousVersion("6.2", "BH.Engine.LadybugTools.Compute.EPWtoCSV(System.String)")]
+        public static string EPWtoCSV(string epwFile, bool includeAdditional = false)
         {
             if (epwFile == null)
             {
@@ -48,21 +50,23 @@ public static string EPWtoCSV(string epwFile)
                 return null;
             }
 
-            BH.oM.Python.PythonEnvironment env = Compute.InstallPythonEnv_LBT(true);
+            PythonEnvironment env = Python.Query.VirtualEnv(Query.ToolkitName());
+            string additionalProperties = includeAdditional ? "True" : "False";
 
-            string pythonScript = String.Join("\n", new List<string>()
+            string pythonScript = string.Join("\n", new List<string>()
             {
+                "import traceback",
                 "from pathlib import Path",
                 "from ladybug.epw import EPW",
-                "from ladybugtools_toolkit.ladybug_extension.epw import to_dataframe",
                 "",
                 $"epw_path = Path(r'{epwFile}')",
                 "csv_path = epw_path.with_suffix('.csv')",
                 "try:",
-                "    to_dataframe(EPW(epw_path.as_posix())).to_csv(csv_path.as_posix())",
+                "    from ladybugtools_toolkit.ladybug_extension.epw import epw_to_dataframe",
+                $"    epw_to_dataframe(EPW(epw_path.as_posix()), include_additional={additionalProperties}).to_csv(csv_path.as_posix())",
                 "    print(csv_path)",
                 "except Exception as exc:",
-                "    print(exc)",
+                "    print(traceback.format_exc())",
             });
 
             return env.RunPythonString(pythonScript).Trim();

LadybugTools_Engine/Compute/EPWtoCustomObject.cs

@@ -4,20 +4,20 @@
  *
  * 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>.      
+ *
+ *
+ * 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;
@@ -26,14 +26,12 @@
 using BH.oM.Base.Attributes;
 using System.Collections.Generic;
 using System.ComponentModel;
-using System.Diagnostics;
-using System.IO;
 
 namespace BH.Engine.LadybugTools
 {
     public static partial class Compute
     {
-        [Description("Convert an EPW file into a time-indexed CSV version.")]
+        [Description("Convert an EPW file into a custom BHoM object.")]
         [Input("epwFile", "An EPW file.")]
         [Output("object", "A BHoM object wrapping a Ladybug EPW object.")]
         public static CustomObject EPWtoCustomObject(string epwFile)
@@ -50,10 +48,11 @@ public static CustomObject EPWtoCustomObject(string epwFile)
                 return null;
             }
 
-            BH.oM.Python.PythonEnvironment env = Compute.InstallPythonEnv_LBT(true);
+            PythonEnvironment env = Python.Query.VirtualEnv(Query.ToolkitName());
 
             string pythonScript = string.Join("\n", new List<string>()
             {
+                "import traceback",
                 "import json",
                 "from pathlib import Path",
                 "from ladybug.epw import EPW",
@@ -62,7 +61,7 @@ public static CustomObject EPWtoCustomObject(string epwFile)
                 "try:",
                 "    print(json.dumps(EPW(epw_path.as_posix()).to_dict()))",
                 "except Exception as exc:",
-                "    print(exc)",
+                "    print(traceback.format_exc())",
             });
 
             string output = env.RunPythonString(pythonScript).Trim();

LadybugTools_Engine/Compute/ExternalComfort.cs

@@ -4,20 +4,20 @@
  *
  * 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>.      
+ *
+ *
+ * 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;
@@ -27,11 +27,9 @@
 using System.Collections.Generic;
 using System.ComponentModel;
 using System.Linq;
-using BH.oM.Base;
-using System.IO;
 using BH.oM.LadybugTools;
 using BH.Engine.Serialiser;
-using Rhino.DocObjects;
+using BH.Engine.Geometry;
 
 namespace BH.Engine.LadybugTools
 {
@@ -40,7 +38,7 @@ public static partial class Compute
         [Description("Run an External Comfort simulation and return results.")]
         [Input("simulationResult", "A simulation result object.")]
         [Input("typology", "An ExternalComfortTypology.")]
-        [Output("externalComfortResult", "An external comfort result object containing simulation results.")]
+        [Output("externalComfort", "An external comfort result object containing simulation results.")]
         public static ExternalComfort ExternalComfort(SimulationResult simulationResult, Typology typology)
         {
             if (simulationResult == null)
@@ -55,6 +53,15 @@ public static ExternalComfort ExternalComfort(SimulationResult simulationResult,
                 return null;
             }
 
+            foreach (Shelter shelter in typology.Shelters)
+            {
+                if (!BH.Engine.Geometry.Create.Polyline(shelter.Vertices).IsPlanar())
+                {
+                    BH.Engine.Base.Compute.RecordError("A shelter in this Typology is not planar.");
+                    return null;
+                }
+            }
+
             // construct the base object
             ExternalComfort externalComfort = new ExternalComfort()
             {
@@ -64,16 +71,17 @@ public static ExternalComfort ExternalComfort(SimulationResult simulationResult,
 
             // send to Python to simulate/load
             string externalComfortJsonStr = System.Text.RegularExpressions.Regex.Unescape(externalComfort.ToJson());
-            BH.oM.Python.PythonEnvironment env = Compute.InstallPythonEnv_LBT(true);
+            PythonEnvironment env = Python.Query.VirtualEnv(Query.ToolkitName());
             string pythonScript = string.Join("\n", new List<string>()
             {
+                "import json",
+                "import traceback",
                 "try:",
-                "    import json",
                 "    from ladybugtools_toolkit.external_comfort.external_comfort import ExternalComfort",
                 $"    external_comfort = ExternalComfort.from_json('{externalComfortJsonStr}')",
                 "    print(external_comfort.to_json())",
                 "except Exception as exc:",
-                "    print(json.dumps({'error': str(exc)}))",
+                "    print(traceback.format_exc())",
             });
 
             string output = env.RunPythonString(pythonScript).Trim().Split(new string[] { "\r\n", "\r", "\n" }, StringSplitOptions.None).Last();

LadybugTools_Engine/Compute/GEMtoHBJSON.cs

@@ -21,6 +21,7 @@
  */
 
 using BH.Engine.Python;
+using BH.oM.Python;
 using BH.oM.Base.Attributes;
 
 using System;
@@ -48,14 +49,15 @@ public static string GEMtoHBJSON(string gem)
                 return null;
             }
 
-            BH.oM.Python.PythonEnvironment env = Compute.InstallPythonEnv_LBT(true);
+            PythonEnvironment env = Python.Query.VirtualEnv(Query.ToolkitName());
 
             string gemFile = System.IO.Path.GetFullPath(gem);
             string outputDirectory = System.IO.Path.GetDirectoryName(gem);
             string fileName = System.IO.Path.GetFileNameWithoutExtension(gem);
 
             string pythonScript = String.Join("\n", new List<string>()
             {
+                "import traceback",
                 "from honeybee.model import Model",
                 "from honeybee_ies.reader import model_from_ies",
                 "",
@@ -64,7 +66,7 @@ public static string GEMtoHBJSON(string gem)
                 $"    hbjson_file = model.to_hbjson(folder=r\"{outputDirectory}\", name=\"{fileName}\")",
                 "    print(hbjson_file)",
                 "except Exception as exc:",
-                "    print(exc)",
+                "    print(traceback.format_exc())",
             });
 
             return env.RunPythonString(pythonScript).Trim();

LadybugTools_Engine/Compute/HBJSONtoGEM.cs

@@ -21,6 +21,7 @@
  */
 
 using BH.Engine.Python;
+using BH.oM.Python;
 using BH.oM.Base.Attributes;
 
 using System;
@@ -48,14 +49,15 @@ public static string HBJSONtoGEM(string hbjson)
                 return null;
             }
 
-            BH.oM.Python.PythonEnvironment env = Compute.InstallPythonEnv_LBT(true);
+            PythonEnvironment env = Python.Query.VirtualEnv(Query.ToolkitName());
 
             string hbjsonFile = System.IO.Path.GetFullPath(hbjson);
             string outputDirectory = System.IO.Path.GetDirectoryName(hbjsonFile);
             string fileName = System.IO.Path.GetFileNameWithoutExtension(hbjsonFile);
 
             string pythonScript = String.Join("\n", new List<string>()
             {
+                "import traceback",
                 "from honeybee.model import Model",
                 "from pathlib import Path",
                 "",
@@ -64,7 +66,7 @@ public static string HBJSONtoGEM(string hbjson)
                 $"    gem_file = model.to_gem(r\"{outputDirectory}\", name=\"{fileName}\")",
                 "    print(gem_file)",
                 "except Exception as exc:",
-                "    print(exc)",
+                "    print(traceback.format_exc())",
             });
 
             return env.RunPythonString(pythonScript).Trim();

LadybugTools_Engine/Compute/InstallPythonEnv_LBT.cs

@@ -23,23 +23,46 @@
 using BH.oM.Base.Attributes;
 using BH.oM.Python;
 using System.ComponentModel;
+using System.Collections.Generic;
 using System.IO;
 
 namespace BH.Engine.LadybugTools
 {
     public static partial class Compute
     {
-        [Description("Create the BHoM Python envrionment for LadybugTools_Toolkit. This creates a replica of what is found in the Pollination installed python environment, for extension using BHoM.")]
+        [Description("Create the BHoM Python environment for LadybugTools_Toolkit. This creates a replica of what is found in the Pollination installed python environment, for extension using BHoM.")]
         [Input("run", "Run the installation process.")]
         [Output("env", "The LadybugTools_Toolkit Python Environment, with BHoM code accessible.")]
         public static PythonEnvironment InstallPythonEnv_LBT(bool run = false)
         {
-            return BH.Engine.Python.Compute.InstallReferencedVirtualenv(
+            string referencedExecutable = @"C:\Program Files\ladybug_tools\python\python.exe";
+
+            PythonEnvironment referencedEnvironment = Python.Compute.InstallReferencedVirtualenv(
                 name: Query.ToolkitName(),
-                executable: @"C:\Program Files\ladybug_tools\python\python.exe",
-                localPackage: Path.Combine(Engine.Python.Query.CodeDirectory(), Query.ToolkitName()),
+                executable: referencedExecutable,
+                localPackage: Path.Combine(Python.Query.CodeDirectory(), Query.ToolkitName()),
                 run: run
             );
+
+            // reload environment to establish the new executable path
+            PythonEnvironment localEnvironment = Python.Query.VirtualEnv(Query.ToolkitName());
+
+            // check here to ensure that referenced executable is using same version as local BHoM environment executable
+            List<string> packagesToCheck = new List<string>() { "lbt-ladybug", "lbt-dragonfly", "lbt-honeybee", "lbt-recipes" };
+            foreach ( string package in packagesToCheck )
+            {
+                string installed = Python.Compute.RunCommandStdout($"{Python.Modify.AddQuotesIfRequired(localEnvironment.Executable)} -m pip freeze | FindStr {package}");
+                string referenced = Python.Compute.RunCommandStdout($"{Python.Modify.AddQuotesIfRequired(referencedEnvironment.Executable)}  -m pip freeze | FindStr {package}");
+                if (installed != referenced)
+                {
+                    Base.Compute.RecordWarning($"BHoM environment {package} does not match referenced package version ({installed} != {referenced}). " +
+                        $"This can be caused by the BHoM version and installed version becoming out of sync. " +
+                        $"Try deleting the {Python.Query.VirtualEnvDirectory("LadybugTools_Toolkit")} directory and re-running the " +
+                        $"{System.Reflection.MethodBase.GetCurrentMethod().Name} method again to fix this.");
+                }
+            }
+
+            return localEnvironment;
         }
     }
 }