feat: test for Grid equality #152

danielolsen · 2020-04-22T20:34:36Z

Purpose

Be able to compare whether two Grid objects are 'equal' in pythonic syntax: x == y. This feature will be useful for our own development (e.g. #150), to ensure that any refactoring does not change how Grid objects are instantiated. It may come in handy for some other analysis functions as well, although I don't have an example off the top of my head.

What is the code doing

In grid.py we add the __eq__ magic method to Grid objects. There is an internal _univ_eq function which will raise an AssertionError if the two inputs are not: a) logically equal (e.g. ints or dicts), b) DataFrames with equal indexes and values, or c) DataFrames with identical indexes and the same columns and data, but with column order transposed. This last condition is relevant for our differently instantiated Grids, which load all the right data in the Plant DataFrame but transpose some columns.

Then, we loop through all elements in fields and transform, ensuring that the values in them are equal (or close enough to equal, given the data modifications we expect).

In mat_reader.py: we correct the transposition of two column names for the bus table we read from the MAT file.

Verification that this works as expected

python
>>> from powersimdata.scenario.scenario import Scenario
>>> from powersimdata.input.grid import Grid
>>> western = Grid(['Western'])
Reading bus.csv
Reading plant.csv
Reading gencost.csv
Reading branch.csv
Reading dcline.csv
Reading sub.csv
Reading bus2sub.csv
Reading zone.csv
>>> western2 = Grid(['Western'])
Reading bus.csv
Reading plant.csv
Reading gencost.csv
Reading branch.csv
Reading dcline.csv
Reading sub.csv
Reading bus2sub.csv
Reading zone.csv
>>> western is western2
False
>>> western == western2
True
>>> eastern = Grid(['Eastern'])
Reading bus.csv
Reading plant.csv
Reading gencost.csv
Reading branch.csv
Reading dcline.csv
Reading sub.csv
Reading bus2sub.csv
Reading zone.csv
>>> western == eastern
False
>>> grid_419 = Scenario('419').state.get_grid()
SCENARIO: test | WesternBase24

--> State
analyze
--> Loading grid
Loading bus
Loading plant
Loading heat_rate_curve
Loading gencost_before
Loading gencost_after
Loading branch
Loading dcline
Loading sub
Loading bus2sub
>>> western == grid_419
True
>>> grid_430 = Scenario('430').state.get_grid()
SCENARIO: test | Eastern2030Independent_OB2_Mesh200

--> State
analyze
--> Loading grid
Loading bus
Loading plant
Loading heat_rate_curve
Loading gencost_before
Loading gencost_after
Loading branch
Loading dcline
Loading sub
Loading bus2sub
>>> western == grid_430
False

Time to review

Approximately one hour, maybe less.

rouille · 2020-04-22T21:32:51Z

powersimdata/input/grid.py

+    def __eq__(self, other):
+        """Used when 'self == other' is evaluated.
+        :param object other: other object to be compared against.
+        :return: *bool*.


:return: (bool). Missing parenthesis

rouille · 2020-04-22T21:36:09Z

powersimdata/input/mat_reader.py

@@ -208,7 +208,7 @@ def column_name_provider():
        'name', 'interconnect_sub_id', 'lat', 'lon', 'interconnect']
    col_name_bus = [
        'bus_id', 'type', 'Pd', 'Qd', 'Gs', 'Bs', 'zone_id', 'Vm', 'Va',
-        'loss_zone', 'baseKV', 'Vmax', 'Vmin', 'lam_P', 'lam_Q', 'mu_Vmax',
+        'baseKV', 'loss_zone', 'Vmax', 'Vmin', 'lam_P', 'lam_Q', 'mu_Vmax',


I mislabelled these 2 column names in the bus data frame? Good catch.

They don't matter for any of our purposes, but this popped up when I was trying to compare bus dataframes between a USA TAMU model and a MATReader model.

rouille · 2020-04-22T21:38:13Z

powersimdata/input/grid.py

+        :return: *bool*.
+        """
+        def _univ_eq(ref, test):
+            """Check for {boolean, dataframe, or column data} equality."""


:param ref: and :param test: are missing

Also, the exception raised are not listed in the docstring. This will have the benefit to help the user understand what is tested and where.

rouille · 2020-04-22T21:45:18Z

powersimdata/input/grid.py

+
+        if not isinstance(other, Grid):
+            other_type = type(other).__name__
+            raise NotImplementedError(f'Unable to compare Grid & {other_type}')


f-string won't work on server

rouille · 2020-04-22T22:17:33Z

It seems like Storage is the only object that is not fully tested in your tests. Scenario 419 allows to test that TAMU == MATREader with empty storage keys.

Should we create a new scenario with Storage to make sure that the data in the gen, gencost and StorageData data frames, list and other objects of the dictionary are correctly filled out by MATReader. I guess we want to do TAMU + storage == MATReader

danielolsen · 2020-04-22T22:37:53Z

@rouille you are right, we were not adequately accounting for storage. I tried comparing scenarios 90 and 159 from the server, which are identical besides the presence of storage in 159, and it was succeeding at first because I was looking to genfuel for the number of storage devices, when I should have been looking at gencost. The fix I just pushed takes care of this.

Documenting that the addition of storage causes a False evaluation:

>>> from powersimdata.scenario.scenario import Scenario
>>> grid_159 = Scenario('159').state.get_grid()
SCENARIO: base | WACA_Anchor_AllMatchCA_2030_SpurUpgrade_Storage1325

--> State
analyze
--> Loading grid
Loading bus
Loading plant
Loading heat_rate_curve
Loading gencost_before
Loading gencost_after
Loading branch
Loading sub
Loading bus2sub
>>> grid_90 = Scenario('90').state.get_grid()
SCENARIO: base | WACA_Anchor_AllMatchCA_2030_SpurUpgrade_1

--> State
analyze
--> Loading grid
Loading bus
Loading plant
Loading heat_rate_curve
Loading gencost_before
Loading gencost_after
Loading branch
Loading sub
Loading bus2sub
>>> grid_90 == grid_159
False
>>> (grid_90.gencost['before'] == grid_159.gencost['before']).all().all()
True
>>> (grid_90.bus == grid_159.bus).all().all()
True
>>> (grid_90.branch == grid_159.branch).all().all()
True
>>> (grid_90.plant == grid_159.plant).all().all()
True
>>> (grid_90.dcline == grid_159.dcline).all().all()
True
>>> (grid_90.sub == grid_159.sub).all().all()
True
>>> len(grid_90.storage['gencost']) == len(grid_159.storage['gencost'])
False

I'm not immediately picturing how we test that TAMU + storage == MATReader. I don't think we can get_grid() in a Create state.

rouille · 2020-04-22T23:17:59Z

Thanks for the additional test and fix. The test is even better. I was not sure that we had two exact scenarios but for storage on the server.

rouille

Thanks for implementing these tests. It looks great.

danielolsen requested review from dmuldrew, rouille and BainanXia April 22, 2020 20:34

danielolsen assigned danielolsen and rouille Apr 22, 2020

rouille reviewed Apr 22, 2020

View reviewed changes

rouille approved these changes Apr 22, 2020

View reviewed changes

danielolsen added 2 commits April 22, 2020 18:21

feat: compare Grid equality

bb43039

fix: transposed loss_zone and baseKV in col_name_bus

32d8c63

danielolsen force-pushed the grid_equality branch from 045cd2c to 32d8c63 Compare April 23, 2020 01:22

danielolsen merged commit 8c6c893 into develop Apr 23, 2020

danielolsen deleted the grid_equality branch April 23, 2020 01:23

This was referenced May 15, 2020

refactor: remove grid fields dependency from develop #182

Merged

test: create tests for grid equality #183

Merged

Lab-ITTeam unassigned danielolsen Jul 15, 2020

ahurli mentioned this pull request Mar 11, 2021

Develop into Master #410

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: test for Grid equality #152

feat: test for Grid equality #152

danielolsen commented Apr 22, 2020 •

edited

Loading

rouille Apr 22, 2020 •

edited

Loading

danielolsen Apr 22, 2020

rouille Apr 22, 2020

danielolsen Apr 22, 2020

rouille Apr 22, 2020

rouille Apr 22, 2020 •

edited

Loading

danielolsen Apr 22, 2020

rouille Apr 22, 2020

danielolsen Apr 22, 2020

rouille commented Apr 22, 2020

danielolsen commented Apr 22, 2020

rouille commented Apr 22, 2020

rouille left a comment

feat: test for Grid equality #152

feat: test for Grid equality #152

Conversation

danielolsen commented Apr 22, 2020 • edited Loading

Purpose

What is the code doing

Verification that this works as expected

Time to review

rouille Apr 22, 2020 • edited Loading

Choose a reason for hiding this comment

danielolsen Apr 22, 2020

Choose a reason for hiding this comment

rouille Apr 22, 2020

Choose a reason for hiding this comment

danielolsen Apr 22, 2020

Choose a reason for hiding this comment

rouille Apr 22, 2020

Choose a reason for hiding this comment

rouille Apr 22, 2020 • edited Loading

Choose a reason for hiding this comment

danielolsen Apr 22, 2020

Choose a reason for hiding this comment

rouille Apr 22, 2020

Choose a reason for hiding this comment

danielolsen Apr 22, 2020

Choose a reason for hiding this comment

rouille commented Apr 22, 2020

danielolsen commented Apr 22, 2020

rouille commented Apr 22, 2020

rouille left a comment

Choose a reason for hiding this comment

danielolsen commented Apr 22, 2020 •

edited

Loading

rouille Apr 22, 2020 •

edited

Loading

rouille Apr 22, 2020 •

edited

Loading