Skip to content

Commit

Permalink
docs: add info on the 'source' parameter in the Grid class
Browse files Browse the repository at this point in the history
  • Loading branch information
rouille committed Nov 19, 2020
1 parent 0400489 commit cbe7fa2
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion powersimdata/input/grid.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ class Grid(object):
"""Grid
:param str/list interconnect: interconnect name(s).
:param str source: model used to build the network.
:param str source: should be either the name of a grid model within the
'*powersimdata/network*' directory or a filename for a '*.mat*' file, which
will be interpreted based on the engine which created it.
:param str engine: engine used to run scenario, if using ScenarioGrid.
:raises TypeError: if source and engine are not both strings.
:raises ValueError: if model or engine does not exist.
Expand Down

0 comments on commit cbe7fa2

Please sign in to comment.