Skip to content

Commit

Permalink
doc: update docstring for create_transformers
Browse files Browse the repository at this point in the history
  • Loading branch information
danielolsen committed Apr 12, 2022
1 parent 06ea3f4 commit 37d7ba6
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion prereise/gather/griddata/hifld/data_process/transmission.py
Original file line number Diff line number Diff line change
Expand Up @@ -546,8 +546,11 @@ def create_transformers(bus, lines, transformer_designs):
:param pandas.DataFrame bus: columns 'sub_id' and 'baseKV'.
:param pandas.DataFrame lines: columns 'from_bus_id', 'to_bus_id', and 'rateA'.
:param pandas.DataFrame transformer_designs: representative transformer data. Index
is (low_kV, high_kV), columns are 'x', 'r', and 'MVA'. 'x' and 'r' values are
per-unit, 'MVA' is in megawatts.
:return: (*pandas.DataFrame*) -- each row is one transformer, columns are
["from_bus_id", "to_bus_id"].
["from_bus_id", "to_bus_id", "x", "r", and "rateA"].
"""
bus_pairs = [
(b, volt_series.sort_values().index[i + 1])
Expand Down

0 comments on commit 37d7ba6

Please sign in to comment.