Add overview and description of the Frequenz Microgrid API#142
Add overview and description of the Frequenz Microgrid API#142tiyash-basu-frequenz merged 4 commits intofrequenz-floss:v0.x.xfrom
Conversation
96cb421 to
0617541
Compare
0617541 to
641bbdf
Compare
f7e792b to
c9c4739
Compare
1066b56 to
2b65ed7
Compare
Fixed |
2b65ed7 to
2a8d0e6
Compare
2a8d0e6 to
9437d31
Compare
9437d31 to
574621f
Compare
|
Rebased on latest upstream head. |
ce687da
ce687da to
b20437f
Compare
|
|
||
| - **Component Graphs:** The API provides a way to list connections between | ||
| components. Connections are represented as pairs of component IDs, describing | ||
| an abstract flow of current according to the passive sign convention. The |
There was a problem hiding this comment.
I find this wording a bit confusing. I suggest to mention that this graph is directed. Otherwise the point about the passive sign convention doesn't make sense. Furthermore I'd suggest to write ... "an abstracted flow of current ..." because I understand that there is an "abstract flow". Also we are following the passive the passive sign convention.
There was a problem hiding this comment.
The lines you are referring to do not talk about graphs at all. How this turns into a graph is explained in the next line.
There was a problem hiding this comment.
I added the term directed in the next line where it mentions graphs.
There was a problem hiding this comment.
Furthermore I'd suggest to write ... "an abstracted flow of current ..." because I understand that there is an "abstract flow". Also we are following the passive the passive sign convention.
Difficult to follow you here. I updated the text again. Note that we want to keep it high-level and not add too much tech detail here.
b20437f to
ab5b3f7
Compare
Signed-off-by: Tiyash Basu <tiyash.basu@frequenz.com>
Signed-off-by: Tiyash Basu <tiyash.basu@frequenz.com>
Signed-off-by: Tiyash Basu <tiyash.basu@frequenz.com>
Signed-off-by: Tiyash Basu <tiyash.basu@frequenz.com>
ab5b3f7 to
4614081
Compare
No description provided.