merge TrustParetoFront to master.

Changed the technology definition to be closer to HSLU database;
Now also able to generate calliope config file from settings.yml and excel.

Author: yiqiaowang-arch

.gitignore

@@ -132,3 +132,4 @@ dmypy.json
 # Pyre type checker
 .pyre/
 *.iml
+.vscode/

.vscode/settings.json

@@ -32,11 +32,11 @@
         {
             "name": "fastapi",
             "depth": 2
-        }
+        },
         {
             "name": "cea",
             "depth": 4
-        }
+        },
         {
             "name": "pandas",
             "depth": 4

README.md

@@ -43,11 +43,11 @@ Currently, this line of code will automatically downgrade pandas to 1.5.3, along
 
 Then, one need to register this plugin in cea-config. In the CEA console, enter the following command to enable the plugin in CEA:
 ```python
-cea-config write --general:plugins cea_energy_hub_optimizer.energy_hub_optimizer.EnergyHubOptimizer
+cea-config write --general:plugins cea_energy_hub_optimizer.energy_hub_optimizer.EnergyHubOptimizer --general:plugins cea_energy_hub_optimizer.calliope_config_constructor.CalliopeConfigConstructor
 ```
 Note that this line will overwrite other existing plugins. If you have other plugins installed, you can add them to the list by separating them with commas. For example:
 ```python
-cea-config write --general:plugins cea_energy_hub_optimizer.energy_hub_optimizer.EnergyHubOptimizer, --general:plugins other_plugin, --general:plugins another_plugin
+cea-config write --general:plugins cea_energy_hub_optimizer.energy_hub_optimizer.EnergyHubOptimizer --general:plugins cea_energy_hub_optimizer.calliope_config_constructor.CalliopeConfigConstructor --general:plugins other_plugin --general:plugins another_plugin
 ```
 You should include **ALL the plugins** in that command, otherwise you may lose already installed plugins.
 
@@ -80,6 +80,13 @@ In the techs_energy_hub.yml file, one can see that there are three different kin
 
 Therefore, three different hypothetical linear DH technologies are set, as shown in the image above. The small one has `energy_cap_min=50` and `energy_cap_max=100`, middle `energy_cap_min=100` and `energy_cap_max=700` and large `energy_cap_min=700` and `energy_cap_max=2000`. The slope of this line is set as `energy_cap` in CHF/kW, and the intercept is set as `purchase` in CHF. Note that each technology must have the same CAPEX on their interceptions (100, 700 and 2000kW) to make sure that both technologies are indifferent to this capacity.
 
+## Uninstall
+To uninstall **all** plugins, simply paste the following command:
+```
+cea-config write --general:plugins ""
+```
+This will overwrite the plugins in cea config file.
+
 ## Development
 To enable auto-completion for both CEA's native methods and the venv that CEA uses, one need to do two things in VSCode:
 1. Add the following lines to the settings.json file (change the path to the path of your CEA **repository**):

cea_energy_hub_optimizer/calliope_config_constructor.py

@@ -0,0 +1,72 @@
+"""
+construct the calliope config yaml file from the settings.yml file and the technology definition excel file.
+"""
+
+from __future__ import division
+from __future__ import print_function
+import cea.config
+import cea.inputlocator
+import cea.plugin
+import os
+import yaml
+from cea_energy_hub_optimizer.tech_from_excel import *
+
+
+__author__ = "Yiqiao Wang"
+__copyright__ = "Copyright 2024, Yiqiao Wang"
+__credits__ = ["Yiqiao Wang"]
+__license__ = "MIT"
+__version__ = "1.0.0"
+__maintainer__ = "Yiqiao Wang"
+__email__ = "[email protected] / [email protected]"
+__status__ = "Production"
+
+
+class CalliopeConfigConstructor(cea.plugin.CeaPlugin):
+    """
+    Define the plugin class - unless you want to customize the behavior, you only really need to declare the class. The
+    rest of the information will be picked up from ``default.config``, ``schemas.yml`` and ``scripts.yml`` by default.
+    """
+
+    pass
+
+
+def main(config: cea.config.Configuration) -> None:
+    # read yaml file from /data/settings.yml and create a nested dictionary
+    # my_config = MyConfig(config)
+    with open(
+        os.path.join(os.path.dirname(__file__), "data", "settings.yml"), "r"
+    ) as file:
+        calliope_config: dict = yaml.safe_load(file)
+        if config.calliope_config_constructor.technology_excel_file == "":
+            tech_excel_path = os.path.join(
+                os.path.dirname(__file__), "data", "example_techDefinition.xlsx"
+            )
+        else:
+            # check if the path belongs to a .xlsx file
+            if config.calliope_config_constructor.technology_excel_file[-5:] != ".xlsx":
+                raise ValueError(
+                    "The technology definition file must be a .xlsx file. Please provide a valid .xlsx file."
+                )
+            tech_excel_path = config.calliope_config_constructor.technology_excel_file
+        techs_subdict = read_tech_definition(filepath=tech_excel_path)
+        calliope_config["techs"].update(techs_subdict)
+
+        store_path = config.calliope_config_constructor.yaml_storage_path
+        if store_path == "":
+            store_path = os.path.join(os.path.dirname(__file__), "data")
+        if not os.path.isdir(store_path):
+            raise ValueError("Please provide a valid folder path.")
+        yaml_file_name = config.calliope_config_constructor.yaml_file_name
+        if yaml_file_name == "":
+            yaml_file_name = "energy_hub_config"
+        yaml_file_name += ".yml"
+        yaml_file_path = os.path.join(store_path, yaml_file_name)
+        with open(yaml_file_path, "w") as file:
+            yaml.dump(calliope_config, file)
+
+        print(f"Yaml file is saved at {yaml_file_path}.")
+
+
+if __name__ == "__main__":
+    main(cea.config.Configuration())