Align heating and cooling load profiles with electric load year #472

Bill-Becker · 2025-01-09T16:07:31Z

Current issue/bug: if a custom ElectricLoad.loads_kw is input along with its corresponding calendar year, and then a heating and/or cooling load is "simulated" by either a commercial reference building (doe_reference_name, or blended_...) or schedule-based flat load (e.g. FlatLoad_16_5) which uses the 2017 year (start day == Sunday), then the load profiles will not be aligned (shifted in the weekdays/weekends). See attached images for current web tool behavior with uploaded electric load for 2024 (starts on Monday) with heating load (starts on Sunday).

This PR fixes this by passing the ElectricLoad.year to the constructors for HeatingLoad and CoolingLoad, and it shifts the simulated CRB or schedule-based flat load profiles to match the starting day of the year input.

Also, now that we have a custom load profile builder for heating loads in the REopt web tool, in which you build an 8760 heating load profile and assign a particular year to it, custom/uploaded heating loads will be used more often. This PR ensures that the year input for heating load profile matches the year input for the electric load profile input. It throws an error if it doesn't match.

Side note: we kind of got away with this for the last year because 2023 (the previous full year) starts on the same day as 2017, but now that 2024 is the most recent full historical year, I suspect this will start to become an issue more.

"Uploaded" 2024 (starts on Monday) Electric Load:

"Simulate Building" 16/5 Schedule Flat Load (2017 is the only option, starts on Sunday):

…red by throwing error if not The get!() function (with "!") add the "year" key/value to the dictionary object, so we can now avoid passing the year kwarg in explicitly.

…if not default 2017

…ulated_load

src/core/heating_cooling_loads.jl

adfarth · 2025-01-09T18:48:52Z

Per the dev call, adding a note to check that the different load years do indeed get sent when using the web tool.

adfarth · 2025-01-09T20:33:46Z

src/core/electric_load.jl

@@ -158,19 +158,13 @@ mutable struct ElectricLoad  # mutable to adjust (critical_)loads_kw based off o
            end


Adding a note here to require the year if a custom load profile is uploaded (here and for the heating loads)

Added this requirement. Validation to check if year is not nothing can happen above the check for loads_kw, doe_reference_name, etc, since the default is assigned for CRB without a year input.

@Bill-Becker I think it might be worth adding this to the CHANGELOG too

Added to changelog.

Also made year required for HeatingLoad and CoolingLoad constructors with their equivalent timeseries load profile input, but that will typically get passed in from the ElectricLoad.year, if missing.

test/runtests.jl

…to load-year-align

…eap years

Bill-Becker · 2025-01-13T19:38:15Z

Per the dev call, adding a note to check that the different load years do indeed get sent when using the web tool.

I confirmed that the year is being passed with an uploaded electric load. The web developers are also working on adding the year input for uploaded heating and cooling loads.

adfarth · 2025-01-13T22:33:40Z

CHANGELOG.md

+### Fixed
+- Align heating and cooling load profiles based on electric load year input, if using custom electric load profile with simulated (CRB or schedule-based flatloads) heating/cooling loads
+### Changed
+- Make `year` input required with `ElectricLoad.loads_kw` input


Also for the custom heating and cooling load inputs, correct? Could you add here?

Updated the line to include any load profile input.

adfarth · 2025-01-13T22:34:58Z

src/core/heating_cooling_loads.jl

@@ -9,11 +9,13 @@
    industrial_reference_name::String = "",  # For ProcessHeatLoad
    blended_industrial_reference_names::Array{String, 1} = String[],  # For ProcessHeatLoad
    blended_industrial_reference_percents::Array{<:Real,1} = Real[],  # For ProcessHeatLoad
-    addressable_load_fraction::Any = 1.0,  # Fraction of input fuel load which is addressable by heating technologies. Can be a scalar or vector with length aligned with use of monthly_mmbtu or fuel_loads_mmbtu_per_hour.
+    city::String = "",
+    year::Union{Int, Nothing} = doe_reference_name ≠ "" || blended_doe_reference_names ≠ String[] ? 2017 : nothing, # CRB profiles are 2017 by default. If providing load profile, specify year of data.    


Does this year check for defaulting to 2017 also need to account for industrial_reference_name and blended_industrial_reference_names? I'm not familiar with exactly how those are used.

Good catch, I'll add that too.

adfarth · 2025-01-13T22:36:47Z

src/core/scenario.jl

                                        )
        max_heat_demand_kw = maximum(dhw_load.loads_kw)
    else
+        # TODO need to add a dummy year here or else will error


@Bill-Becker is this still a pending TODO?

Nope, done.

adfarth · 2025-01-13T22:59:50Z

@Bill-Becker do you think it matters that in ElectricTariff the year is still defaulted to 2022?

adfarth · 2025-01-13T23:40:25Z

test/runtests.jl

+            input_data = JSON.parsefile("./scenarios/load_year_align.json")
+            year = 2024
+            # ElectricLoad.loads_kw is 2024, and heating and cooling loads are shifted to align
+            # Use a FlatLoad_16_5 shifted to 2024 (Monday start) with the web tool's custom load builder


this isn't that important, but what does this comment mean? That the flat load has already been shifted after getting the 2017 version from the web tool?

I just built a load with the year=2024, and the web tool aligned the weekday/weekend profiles to the 2024 year.

adfarth

@Bill-Becker just a few small questions and asks, but I think this is good to merge after addressing those. These are great fixes!

…le inputs too

…ad.year which is now required.

…to load-year-align

Bill-Becker · 2025-01-14T05:24:46Z

@Bill-Becker do you think it matters that in ElectricTariff the year is still defaulted to 2022?

Removed the year default.

Bill-Becker added 14 commits January 6, 2025 22:45

Improve test description, avoid using Dates.jl in runtests.jl

5511ac2

Add leap year test input file

3a620f5

Fix input file path formatting

fdcdd6a

Include 2023 and 2024 years for all new tests

fc9208b

Update year input for HeatingLoad

dd13bed

Add year input for CoolingLoad

60376db

Remove year=2017 requirement for ElectricLoad

f472f9a

Avoid passing year twice to constructors, make load consistency requi…

160ed67

…red by throwing error if not The get!() function (with "!") add the "year" key/value to the dictionary object, so we can now avoid passing the year kwarg in explicitly.

Shift CRB load profiles to match the starting day of the input year, …

93fac74

…if not default 2017

Fix leap year handling for helper function get_monthly_energy for sim…

a6c42ca

…ulated_load

Update simulated_load() for year input and alignment across loads

b244565

Add tests for load alignment based on year input

d3b5c60

Merge branch 'develop' into load-year-align

64b54a0

Update changelog for load align fix

5384b5f

Bill-Becker requested a review from adfarth January 9, 2025 16:36

This comment was marked as off-topic.

Sign in to view

adfarth reviewed Jan 9, 2025

View reviewed changes

src/core/heating_cooling_loads.jl Outdated Show resolved Hide resolved

adfarth reviewed Jan 9, 2025

View reviewed changes

src/core/heating_cooling_loads.jl Outdated Show resolved Hide resolved

This comment was marked as outdated.

Sign in to view

adfarth reviewed Jan 9, 2025

View reviewed changes

adfarth and others added 2 commits January 9, 2025 13:44

small text updates

be8197c

Require year input, in particular with ElectricLoad.loads_kw input

7af1601

Also made year required for HeatingLoad and CoolingLoad constructors with their equivalent timeseries load profile input, but that will typically get passed in from the ElectricLoad.year, if missing.

adfarth reviewed Jan 10, 2025

View reviewed changes

test/runtests.jl Show resolved Hide resolved

adfarth reviewed Jan 10, 2025

View reviewed changes

test/runtests.jl Show resolved Hide resolved

Bill-Becker and others added 5 commits January 10, 2025 12:21

Add year input to fix tests with loads_kw

c100eee

small update to normalize explanation

9d2ea82

Change CRB profile year alignment strategy

2b10ede

Add more updates to Changelog.

e5a55e3

Merge branch 'load-year-align' of https://github.com/NREL/REopt.jl in…

c91743c

…to load-year-align

Bill-Becker added 2 commits January 13, 2025 12:06

Fix test input for doe_reference_name

cdcd928

Update test with get_monthly_energy() now that it's consistent with l…

5f46a78

…eap years

adfarth reviewed Jan 13, 2025

View reviewed changes

updating CoolingLoad help text

d62ef0e

adfarth reviewed Jan 13, 2025

View reviewed changes

adfarth approved these changes Jan 13, 2025

View reviewed changes

Bill-Becker added 4 commits January 13, 2025 22:08

Update changelog for required year for heating and cooling load profi…

5d700be

…le inputs too

Make ElectricTariff.year = nothing by default, passed from ElectricLo…

74d362d

…ad.year which is now required.

Include industrial_reference_names for process heat default year of 2017

375289e

Merge branch 'load-year-align' of https://github.com/NREL/REopt.jl in…

f67b06c

…to load-year-align

Bill-Becker merged commit 2e4b8e3 into develop Jan 14, 2025
2 checks passed

Bill-Becker deleted the load-year-align branch January 14, 2025 15:32

Bill-Becker mentioned this pull request Jan 14, 2025

Jan 2025 Updates: Load Year Fixes, ASHP Max Dispatch #473

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Align heating and cooling load profiles with electric load year #472

Align heating and cooling load profiles with electric load year #472

Bill-Becker commented Jan 9, 2025 •

edited

Loading

This comment was marked as off-topic.

adfarth commented Jan 9, 2025

This comment was marked as outdated.

adfarth Jan 9, 2025 •

edited

Loading

Bill-Becker Jan 10, 2025

adfarth Jan 10, 2025

Bill-Becker Jan 13, 2025

Bill-Becker commented Jan 13, 2025

adfarth Jan 13, 2025

Bill-Becker Jan 14, 2025

adfarth Jan 13, 2025

Bill-Becker Jan 14, 2025

adfarth Jan 13, 2025

Bill-Becker Jan 14, 2025

adfarth commented Jan 13, 2025

adfarth Jan 13, 2025

Bill-Becker Jan 14, 2025

adfarth left a comment

Bill-Becker commented Jan 14, 2025

		@@ -158,19 +158,13 @@ mutable struct ElectricLoad # mutable to adjust (critical_)loads_kw based off o
		end

Align heating and cooling load profiles with electric load year #472

Align heating and cooling load profiles with electric load year #472

Conversation

Bill-Becker commented Jan 9, 2025 • edited Loading

This comment was marked as off-topic.

adfarth commented Jan 9, 2025

This comment was marked as outdated.

adfarth Jan 9, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Bill-Becker commented Jan 13, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adfarth commented Jan 13, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adfarth left a comment

Choose a reason for hiding this comment

Bill-Becker commented Jan 14, 2025

Bill-Becker commented Jan 9, 2025 •

edited

Loading

adfarth Jan 9, 2025 •

edited

Loading