Implement convert_component! for StandardLoad <- PowerLoad #1022

GabrielKS · 2023-10-18T15:41:11Z

This will be used for a new system in PowerSystemCaseBuilder. Includes unit tests.

Define convert_component! for conversions from PowerLoad to StandardLoad
Add unit tests for this method along the lines of existing convert_component! unit tests
Refactor convert_component! unit tests to remove repetition

- Define convert_component! for conversions from PowerLoad to StandardLoad - Add unit tests for this method along the lines of existing convert_component! unit tests - Refactor convert_component! unit tests to remove repetition

codecov · 2023-10-18T16:07:02Z

Codecov Report

Merging #1022 (703762a) into main (68cceae) will increase coverage by 0.00%.
The diff coverage is 77.77%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1022   +/-   ##
=======================================
  Coverage   85.37%   85.37%           
=======================================
  Files         169      169           
  Lines        7639     7646    +7     
=======================================
+ Hits         6522     6528    +6     
- Misses       1117     1118    +1

Flag	Coverage Δ
unittests	`85.37% <77.77%> (+<0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files	Coverage Δ
src/base.jl	`92.25% <77.77%> (-0.18%)`	⬇️

... and 2 files with indirect coverage changes

jd-lara · 2023-10-18T16:15:14Z

src/base.jl

+function convert_component!(
+    new_type::Type{StandardLoad},
+    old_load::PowerLoad,
+    sys::System;
+    kwargs...,


In Julia the argument after the ! is the one being modified. In this case is the system that is being changed.

Suggested change

function convert_component!(

new_type::Type{StandardLoad},

old_load::PowerLoad,

sys::System;

kwargs...,

function convert_component!(

sys::System,

old_load::PowerLoad

new_type::Type{StandardLoad},

;

kwargs...,

The existing convert_component! methods have the new type as the first argument, then the old component, then the system:

PowerSystems.jl/src/base.jl

Lines 1922 to 1927 in 1b7c1c0

function convert_component!(

linetype::Type{MonitoredLine},

line::Line,

sys::System;

kwargs...,

)

and

PowerSystems.jl/src/base.jl

Lines 1956 to 1961 in 1b7c1c0

function convert_component!(

linetype::Type{Line},

line::MonitoredLine,

sys::System;

kwargs...,

)

and I was maintaining consistency with those. Should I change those existing methods to follow the Julia convention?

Yes, I should. Fixed in 703762a.

jd-lara · 2023-10-18T16:15:34Z

test/test_powersystemconstructors.jl

@@ -132,26 +132,51 @@ end
 end

 @testset "Test component conversion" begin
-    test_conversion =
+    # Reusable resources for this testset
+    load_test_system = () -> System(joinpath(BAD_DATA, "case5_re.m"))


Use PSB here

Done in 9c7ef0f, reverted the old test and now use PSB for the new one.

jd-lara

Some changes are required.

github-actions · 2023-10-23T21:52:59Z

test/test_powersystemconstructors.jl

+            ta = TimeSeries.TimeArray(dates, data, [component_name])
+            time_series = SingleTimeSeries(; name = ts_name, data = ta)
+            add_time_series!(sys, old_component, time_series)
+            @test get_time_series(SingleTimeSeries, old_component, ts_name) isa SingleTimeSeries


[JuliaFormatter] _{reported by reviewdog 🐶}

Suggested change

@test get_time_series(SingleTimeSeries, old_component, ts_name) isa SingleTimeSeries

@test get_time_series(SingleTimeSeries, old_component, ts_name) isa

SingleTimeSeries

Fixed in 703762a

github-actions · 2023-10-23T21:52:59Z

test/test_powersystemconstructors.jl

+            new_component = get_component(StandardLoad, sys, component_name)
+            @test !isnothing(new_component)
+            @test get_name(new_component) == component_name
+            @test get_time_series(SingleTimeSeries, new_component, ts_name) isa SingleTimeSeries


[JuliaFormatter] _{reported by reviewdog 🐶}

Suggested change

@test get_time_series(SingleTimeSeries, new_component, ts_name) isa SingleTimeSeries

@test get_time_series(SingleTimeSeries, new_component, ts_name) isa

SingleTimeSeries

Fixed in 703762a

github-actions · 2023-10-23T21:52:59Z

test/test_powersystemconstructors.jl

+            @test get_time_series(SingleTimeSeries, new_component, ts_name) isa SingleTimeSeries
+            # Conversion back is not implemented
+        end
+


[JuliaFormatter] _{reported by reviewdog 🐶}

Suggested change

Fixed in 703762a

- For all non-deprecated convert_component! methods, use the argument order: system, old component, new component type - Deprecate old convert_component! methods for backwards compatibility - Test deprecation - Run formatter

jd-lara

@GabrielKS you need to run the formatter

Implement convert_component! for StandardLoad <- PowerLoad

1b7c1c0

- Define convert_component! for conversions from PowerLoad to StandardLoad - Add unit tests for this method along the lines of existing convert_component! unit tests - Refactor convert_component! unit tests to remove repetition

GabrielKS requested review from jd-lara and sourabhdalvi October 18, 2023 15:41

This was referenced Oct 18, 2023

Add system with StandardLoad NREL-Sienna/PowerSystemCaseBuilder.jl#67

Merged

Fix #8, add tests using PowerSystemCaseBuilder NREL-Sienna/PowerAnalytics.jl#14

Merged

jd-lara reviewed Oct 18, 2023

View reviewed changes

jd-lara requested changes Oct 18, 2023

View reviewed changes

Revert unit test refactor, test new method separately

9c7ef0f

github-actions bot reviewed Oct 23, 2023

View reviewed changes

Change convert_component! argument order

703762a

- For all non-deprecated convert_component! methods, use the argument order: system, old component, new component type - Deprecate old convert_component! methods for backwards compatibility - Test deprecation - Run formatter

jd-lara reviewed Oct 25, 2023

View reviewed changes

jd-lara self-requested a review October 25, 2023 19:17

jd-lara approved these changes Oct 25, 2023

View reviewed changes

jd-lara merged commit 5b08a27 into main Oct 25, 2023
10 checks passed

jd-lara deleted the gks/convert-load branch October 25, 2023 19:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement convert_component! for StandardLoad <- PowerLoad #1022

Implement convert_component! for StandardLoad <- PowerLoad #1022

GabrielKS commented Oct 18, 2023

codecov bot commented Oct 18, 2023 •

edited

Loading

jd-lara Oct 18, 2023

GabrielKS Oct 18, 2023

GabrielKS Oct 24, 2023

jd-lara Oct 18, 2023

GabrielKS Oct 23, 2023 •

edited

Loading

jd-lara left a comment

github-actions bot Oct 23, 2023

GabrielKS Oct 24, 2023

github-actions bot Oct 23, 2023

GabrielKS Oct 24, 2023

github-actions bot Oct 23, 2023

GabrielKS Oct 24, 2023

jd-lara left a comment

	function convert_component!(
	linetype::Type{MonitoredLine},
	line::Line,
	sys::System;
	kwargs...,
	)

	function convert_component!(
	linetype::Type{Line},
	line::MonitoredLine,
	sys::System;
	kwargs...,
	)

	@test get_time_series(SingleTimeSeries, old_component, ts_name) isa SingleTimeSeries
	@test get_time_series(SingleTimeSeries, old_component, ts_name) isa
	SingleTimeSeries

Implement convert_component! for StandardLoad <- PowerLoad #1022

Implement convert_component! for StandardLoad <- PowerLoad #1022

Conversation

GabrielKS commented Oct 18, 2023

This will be used for a new system in PowerSystemCaseBuilder. Includes unit tests.

codecov bot commented Oct 18, 2023 • edited Loading

Codecov Report

jd-lara Oct 18, 2023

Choose a reason for hiding this comment

GabrielKS Oct 18, 2023

Choose a reason for hiding this comment

GabrielKS Oct 24, 2023

Choose a reason for hiding this comment

jd-lara Oct 18, 2023

Choose a reason for hiding this comment

GabrielKS Oct 23, 2023 • edited Loading

Choose a reason for hiding this comment

jd-lara left a comment

Choose a reason for hiding this comment

github-actions bot Oct 23, 2023

Choose a reason for hiding this comment

GabrielKS Oct 24, 2023

Choose a reason for hiding this comment

github-actions bot Oct 23, 2023

Choose a reason for hiding this comment

GabrielKS Oct 24, 2023

Choose a reason for hiding this comment

github-actions bot Oct 23, 2023

Choose a reason for hiding this comment

GabrielKS Oct 24, 2023

Choose a reason for hiding this comment

jd-lara left a comment

Choose a reason for hiding this comment

codecov bot commented Oct 18, 2023 •

edited

Loading

GabrielKS Oct 23, 2023 •

edited

Loading