From cbe7fa286a7ed7d303175caea2cf2954c21a2006 Mon Sep 17 00:00:00 2001 From: Ben RdO Date: Wed, 18 Nov 2020 13:26:26 -0800 Subject: [PATCH] docs: add info on the 'source' parameter in the Grid class --- powersimdata/input/grid.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/powersimdata/input/grid.py b/powersimdata/input/grid.py index 6b8aaaa64..a3dab0f2e 100644 --- a/powersimdata/input/grid.py +++ b/powersimdata/input/grid.py @@ -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.