search

plasmo-dev / Plasmo.jl

A Platform for Scalable Modeling and Optimization
Other
143 stars 20 forks source link

Added details to docs for accessing variables on nodes and subgraphs #102

Closed dlcole3 closed 4 months ago

dlcole3 commented 4 months ago

I have gotten some feedback from some different people that the graphs are not always intuitive to someone with little optimization background, and when I was first using Plasmo, I did not understand how to acccess solutions or variables. I added to the gas network tutorial a section on querying solutions and accessing variables and explain the "nested" reference structure of nodes on subgraphs and variables on nodes.

codecov-commenter commented 4 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 87.96%. Comparing base (1702300) to head (ff4f2b5).

:exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #102 +/- ## ========================================== + Coverage 87.79% 87.96% +0.16% ========================================== Files 19 19 Lines 2368 2368 ========================================== + Hits 2079 2083 +4 + Misses 289 285 -4 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

jalving commented 4 months ago

Thanks @dlcole3, better documentation is always welcome. You hit on some interesting points about how confusing this example can be with regard to ordering of subgraphs. Once the next release is done (it's getting close) we will revisit a lot of documentation updates and improved tutorials.

dlcole3 commented 4 months ago

Thanks @dlcole3, better documentation is always welcome. You hit on some interesting points about how confusing this example can be with regard to ordering of subgraphs. Once the next release is done (it's getting close) we will revisit a lot of documentation updates and improved tutorials.

No problem @jalving. I would also like to add some details on the aggregation mapping, but I have not gotten to that yet. I had another grad student reach out to me about using the gas network model for a project they are working on, so I figured I would put this information in the docs so that I could point them to it.