Merge pull request #122 from pnnl/develop

Develop

Author: d3j331

README.md

@@ -1,6 +1,6 @@
 # Transactive Energy Simulation Platform (TESP)
 
-Copyright (c) 2017-2022, Battelle Memorial Institute
+Copyright (c) 2017-2023 Battelle Memorial Institute
 
 Documentation: http://tesp.readthedocs.io
 
@@ -23,6 +23,7 @@ Change log:
 - v1.1.3  Updated some documentation and build patches.
 - v1.1.4  Updates to auto testing and minors bug fixes for Comm cases using HELICS3.0.
 - v1.1.5  Updates to auto testing and minors bug fixes for install and a better loadshed example.
-- v1.2.0  Updates to auto testing and minors bug fixes. Version changes for HELICS 3.3, GridLABD 5.0. Reorganize environment and updated documentation. Add more loadshed N3 examples.
+- v1.2.0  Updates to auto testing and minors bug fixes. Version changes for HELICS 3.3, GridLAB-D 5.0. Reorganize environment and updated documentation. Add more loadshed N3 examples.
 - v1.2.1  Fixed python shell files, fixed complex python to use helics complex.
 - v1.2.2  Fixed the installation for Ubuntu 22.04.
+- v1.3.0  Refactor the TESP PyPI api. Upgrade all models(GridLAB-D, EnergyPlus, NS3) to work with HELICS 3.4. Add modifier.py for GridLAB-D models

data/comm/commshed.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2020-2022 Battelle Memorial Institute
+# Copyright (c) 2020-2023 Battelle Memorial Institute
 # file: commshed.py
 import sys
 import helics
@@ -29,7 +29,7 @@ def helics_loop(tmax, market_period, thresh_kW, max_offset_kW):
     for i in range(subCount):
         sub = helics.helicsFederateGetInputByIndex(hFed, i)
         key = helics.helicsInputGetName(sub)
-        target = helics.helicsSubscriptionGetTarget(sub)
+        target = helics.helicsInputGetTarget(sub)
         print('HELICS subscription key', i, key, 'target', target)
         if 'distribution_load' in target:
             sub_load = sub

data/comm/eplots.py

@@ -1,10 +1,10 @@
-# Copyright (C) 2021-2022 Battelle Memorial Institute
+# Copyright (c) 2021-2023 Battelle Memorial Institute
 # file: eplots.py
 # usage 'python3 eplots.py metrics_root my_title my_png'
 
 import sys
 
-import tesp_support.process_eplus as ep
+import tesp_support.api.process_eplus as ep
 
 root = 'eplus'
 title = None

data/comm/gplots.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2021-2022 Battelle Memorial Institute
+# Copyright (c) 2021-2023 Battelle Memorial Institute
 # file: gplots.py
 # usage 'python3 gplots.py metrics_root'
 
@@ -8,7 +8,7 @@
 
 import matplotlib.pyplot as plt
 
-import tesp_support.process_gld as gp
+import tesp_support.api.process_gld as gp
 
 name_root = sys.argv[1]
 

data/energyplus/README.md

@@ -1,6 +1,6 @@
 # Commercial Building Models for DSO+T Study
 
-Copyright (c) 2019-2022, Battelle Memorial Institute
+Copyright (c) 2019-2023 Battelle Memorial Institute
 
 These are post-1980 reference buildings for Houston, TX
 

data/entities/glm_objects.json

@@ -0,0 +1,135 @@
+{
+  "Config": [
+    ["User Name", "James Bond", "", "TEXT", "user_name"],
+    ["Case Name", "test", "", "TEXT", "case_name"],
+    ["Start Time", "2013-07-01 00:00:00", "Date/Time", "DATE", "StartTime"],
+    ["End Time", "2013-07-01 00:00:00", "Date/Time", "DATE", "EndTime"],
+    ["Working Directory", "$TESPDIR/examples/test", "Path", "PATH", "WorkingDirectory"],
+    ["Federation of models", "NO", "", "TEXT", "federation", "yesNoChoices"],
+    ["Use MATPower", "NO", "", "TEXT", "tso", "yesNoChoices"],
+    ["Use GridLabD", "NO", "", "TEXT", "gld", "yesNoChoices"],
+    ["Use Substation", "NO", "", "TEXT", "sub", "yesNoChoices"],
+    ["Use EnergyPlus", "NO", "", "TEXT", "eplus", "yesNoChoices"],
+    ["Use Weather", "NO", "", "TEXT", "met", "yesNoChoices"],
+    ["Use Player", "NO", "", "TEXT", "csv", "yesNoChoices"]
+  ],
+  "BackboneFiles": [
+    ["GridLAB-D Taxonomy Choice", "TE_Base", "File name", "TEXT", "TaxonomyChoice", "taxonomyChoices"],
+    ["Feeder Name Prefix", "Fdr1_", "Prepend to Taxonomy Names", "TEXT", "NamePrefix"],
+    ["PYPOWER Base File", "ppbasefile.py", "", "TEXT", "PYPOWERFile"],
+    ["Weather Type", "TMY3", "TMY2/TMY3", "TEXT", "WeatherChoice", "weatherChoices"]
+  ],
+  "WeatherPrep": [
+    ["Weather name", "", "", "TEXT", "weather_name"],
+    ["Weather path", "$TESPDIR/data/weather", "Path", "PATH", "weather_path"],
+    ["Weather file", "", "", "TEXT", "weather_file"],
+    ["Weather choice", "TMY3", "", "TEXT", "weather_choice", "weatherChoices"],
+    ["Weather source", "WA-Yakima_Air_Terminal.tmy3", "File or URL", "TEXT", "data_source"],
+    ["Latitude", 32.133, "deg", "REAL", "latitude"],
+    ["Longitude", -110.95, "deg", "REAL", "longitude"],
+    ["Altitude", 0.0, "m", "REAL", "altitude"],
+    ["Time zone meridian", -6, "deg", "INTEGER", "tz_meridian"],
+    ["Interpolate", "QUADRATIC", "", "TEXT", "interpolate", "interpolateChoices"]
+  ],
+  "FeederGenerator": [
+    ["GridLAB-D Time Step", 15, "s", "INTEGER", "MinimumStep"],
+    ["Metrics Time Step", 300, "s", "INTEGER", "MetricsInterval"],
+    ["Electric Cooling Penetration", 90, "%", "REAL", "ElectricCoolingPercentage"],
+    ["Electric Cooling Participation", 50, "%", "REAL", "ElectricCoolingParticipation"],
+    ["Water Heater Penetration", 75, "%", "REAL", "WaterHeaterPercentage"],
+    ["Water Heater Participation", 25, "%", "REAL", "WaterHeaterParticipation"],
+    ["Solar Penetration", 0, "%", "REAL", "SolarPercentage"],
+    ["Storage Penetration", 0, "%", "REAL", "StoragePercentage"],
+    ["Solar Inverter Mode", "CONSTANT_PF", "", "TEXT", "SolarInverterMode", "inverterPVModes"],
+    ["Storage Inverter Mode", "CONSTANT_PF", "", "TEXT", "StorageInverterMode", "inverterBatteryModes"],
+    ["Billing Mode", "TIERED", "", "TEXT", "BillingMode", "billingModes"],
+    ["Monthly Fee", 13.0, "$", "REAL", "MonthlyFee"],
+    ["Price", 0.102013, "$/kwh", "REAL", "Price"],
+    ["Tier 1 Energy", 500.0, "kwh", "REAL", "Tier1Energy"],
+    ["Tier 1 Price", 0.117013, "$/kwh", "REAL", "Tier1Price"],
+    ["Tier 2 Energy", 1000.0, "kwh", "REAL", "Tier2Energy"],
+    ["Tier 2 Price", 0.122513, "$/kwh", "REAL", "Tier2Price"],
+    ["Tier 3 Energy", 0.0, "kwh", "REAL", "Tier3Energy"],
+    ["Tier 3 Price", 0.0, "$/kwh", "REAL", "Tier3Price"]
+  ],
+  "PYPOWERConfiguration": [
+    ["Power Flow Time Step", 15, "s", "INTEGER", "PFStep"],
+    ["OPF Type", "DC", "for dispatch and price", "TEXT", "ACOPF", "powerFlowChoices"],
+    ["PF Type", "DC", "for voltage", "TEXT", "ACPF", "powerFlowChoices"],
+    ["Substation Voltage", 230.0, "kV", "REAL", "TransmissionVoltage"],
+    ["Substation Base", 12.0, "MVA", "REAL", "TransformerBase"],
+    ["GLD Bus Number", 7, "", "INTEGER", "GLDBus"],
+    ["GLD Load Scale", 20, "", "REAL", "GLDScale"],
+    ["Non-responsive Loads", "NonGLDLoad.txt", "CSV File", "TEXT", "CSVLoadFile"],
+    ["Unit Out", 2, "", "INTEGER", "UnitOut"],
+    ["Unit Outage Start", "2013-07-02 07:00:00", "Date/Time", "DATE", "UnitOutStart"],
+    ["Unit Outage End", "2013-07-02 19:00:00", "Date/Time", "DATE", "UnitOutEnd"],
+    ["Branch Out", 3, "", "INTEGER", "BranchOut"],
+    ["Branch Outage Start", "", "Date/Time", "DATE", "BranchOutStart"],
+    ["Branch Outage End", "", "Date/Time", "DATE", "BranchOutEnd"]
+  ],
+  "EplusConfiguration": [
+    ["Energy+ Base File", "SchoolDualController", "", "TEXT", "BuildingChoice", "namedBuildingTypes"],
+    ["Energy+ EMS File", "emsFNCS/emsSchoolDualController", "", "TEXT", "EMSFile"],
+    ["Time Steps per Hour", 12, "", "INTEGER", "StepsPerHour"],
+    ["Eplus Bus", "Feeder_head", "", "TEXT", "EnergyPlusBus"],
+    ["Eplus Service Voltage", 480.0, "V", "REAL", "EnergyPlusServiceV", "eplusVoltageChoices"],
+    ["Eplus Transformer Size", 150.0, "kVA", "REAL", "EnergyPlusXfmrKva"],
+    ["Reference Price", 0.02, "$", "REAL", "ReferencePrice"],
+    ["Ramp", 25.0, "degF/$", "REAL", "Slope"],
+    ["Delta Limit Hi", 4.0, "degF", "REAL", "OffsetLimitHi"],
+    ["Delta Limit Lo", 4.0, "degF", "REAL", "OffsetLimitLo"],
+    ["Use EnergyPlusAgent", "NO", "", "TEXT", "federation", "yesNoChoices"]
+  ],
+  "AgentPrep": [
+    ["Market Clearing Period", 300, "s", "INTEGER", "MarketClearingPeriod"],
+    ["Agent Time Step", 15, "s", "INTEGER", "TimeStepGldAgents"],
+    ["Initial Price", 0.02078, "$", "REAL", "InitialPriceMean"],
+    ["Std Dev Price", 0.00361, "$", "REAL", "InitialPriceStdDev"],
+    ["Ramp Lo", 0.5, "$(std dev)/degF", "REAL", "ThermostatRampLo"],
+    ["Ramp Hi", 3.0, "$(std dev)/degF", "REAL", "ThermostatRampHi"],
+    ["Band Lo", 1.0, "degF", "REAL", "ThermostatBandLo"],
+    ["Band Hi", 3.0, "degF", "REAL", "ThermostatBandHi"],
+    ["Offset Limit Lo", 2.0, "degF", "REAL", "ThermostatOffsetLimitLo"],
+    ["Offset Limit Hi", 6.0, "degF", "REAL", "ThermostatOffsetLimitHi"],
+    ["Price Cap Lo", 1.00, "$", "REAL", "PriceCapLo"],
+    ["Price Cap Hi", 3.00, "$", "REAL", "PriceCapHi"]
+  ],
+  "ThermostatSchedule": [
+    ["Weekday Wakeup Start Lo", 5.0, "hour of day", "REAL", "WeekdayWakeStartLo"],
+    ["Weekday Wakeup Start Hi", 6.5, "hour of day", "REAL", "WeekdayWakeStartHi"],
+    ["Weekday Wakeup Set Lo", 78.0, "degF", "REAL", "WeekdayWakeSetLo"],
+    ["Weekday Wakeup Set Hi", 80.0, "degF", "REAL", "WeekdayWakeSetHi"],
+    ["Weekday Daylight Start Lo", 8.0, "hour of day", "REAL", "WeekdayDaylightStartLo"],
+    ["Weekday Daylight Start Hi", 9.0, "hour of day", "REAL", "WeekdayDaylightStartHi"],
+    ["Weekday Daylight Set Lo", 84.0, "degF", "REAL", "WeekdayDaylightSetLo"],
+    ["Weekday Daylight Set Hi", 86.0, "degF", "REAL", "WeekdayDaylightSetHi"],
+    ["Weekday Evening Start Lo", 17.0, "hour of day", "REAL", "WeekdayEveningStartLo"],
+    ["Weekday Evening Start Hi", 18.5, "hour of day", "REAL", "WeekdayEveningStartHi"],
+    ["Weekday Evening Set Lo", 78.0, "degF", "REAL", "WeekdayEveningSetLo"],
+    ["Weekday Evening Set Hi", 80.0, "degF", "REAL", "WeekdayEveningSetHi"],
+    ["Weekday Night Start Lo", 22.0, "hour of day", "REAL", "WeekdayNightStartLo"],
+    ["Weekday Night Start Hi", 23.5, "hour of day", "REAL", "WeekdayNightStartHi"],
+    ["Weekday Night Set Lo", 72.0, "degF", "REAL", "WeekdayNightSetLo"],
+    ["Weekday Night Set Hi", 74.0, "degF", "REAL", "WeekdayNightSetHi"],
+    ["Weekend Daylight Start Lo", 8.0, "hour of day", "REAL", "WeekendDaylightStartLo"],
+    ["Weekend Daylight Start Hi", 9.0, "hour of day", "REAL", "WeekendDaylightStartHi"],
+    ["Weekend Daylight Set Lo", 76.0, "degF", "REAL", "WeekendDaylightSetLo"],
+    ["Weekend Daylight Set Hi", 84.0, "degF", "REAL", "WeekendDaylightSetHi"],
+    ["Weekend Night Start Lo", 22.0, "hour of day", "REAL", "WeekendNightStartLo"],
+    ["Weekend Night Start Hi", 24.0, "hour of day", "REAL", "WeekendNightStartHi"],
+    ["Weekend Night Set Lo", 72.0, "degF", "REAL", "WeekendNightSetLo"],
+    ["Weekend Night Set Hi", 74.0, "degF", "REAL", "WeekendNightSetHi"]
+  ],
+  "PlayerStructure": [
+    ["Prefix for message file", "", "", "TEXT", "prefix"],
+    ["How many rows in files", "", "", "INTEGER", "vals_rows"],
+    ["Power factor", "0.57", "", "REAL", "power_factor"],
+    ["Time interval", "", "s", "INTEGER", "dt_load_collector"],
+    ["Start date", "", "", "DATE", "date_time_str"],
+    ["Data Path/File", "", "", "TEXT", "data_path"],
+    ["Output", "True", "", "TEXT", "output","trueFalseChoices"],
+    ["Output history", "True", "", "TEXT", "output_hist", "trueFalseChoices"],
+    ["Straight lookup or generator lookup", "True", "", "TEXT", "load", "trueFalseChoices"]
+  ]
+}