Docs fixes and add to README #38
Conversation
Codecov Report
@@ Coverage Diff @@
## main #38 +/- ##
=======================================
Coverage 85.89% 85.89%
=======================================
Files 5 5
Lines 234 234
=======================================
Hits 201 201
Misses 33 33 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
README.md
Outdated
| using HiGHS | ||
| using JuMP | ||
|
|
||
| system = SystemRT(components...) |
There was a problem hiding this comment.
This should have a bit more context now. The example model appears after a section describing all the components and here the names of the components are listed (although I still haven't included all the code needed to construct them).
README.md
Outdated
| @constraint( | ||
| model, | ||
| energy_balance[t in datetimes], | ||
| sum(model[:generation][u, t] for u in units) == sum(load(l, t) for l in axiskeys(load, 1)) |
There was a problem hiding this comment.
where does load come from? or is this jump magic introducing it?
There was a problem hiding this comment.
load is defined above from get_load(system). It is a KeyedArray so uses () for indexing by the names of the keys within the @constraint definition.
README.md
Outdated
| optimize!(model) | ||
| ``` | ||
|
|
||
| ## Additional Features of the System |
There was a problem hiding this comment.
I'd maybe move this section first and drop the Additional
README.md
Outdated
|
|
||
| The following is an example of how the data stored in a `SystemRT` object can be used to build a JuMP model. | ||
| The objective of the model is to solve a simple energy balance problem, where a set of loads (demands) need to be met by generation (supply), for the minimum possible cost. | ||
| Assume we have an instance of a system (see [`SystemRT`](@ref) for details of all the components in a `SystemRT`). |
There was a problem hiding this comment.
the @ref links don't work in a readme - replace these with stable docs links
There was a problem hiding this comment.
Links are to the dev docs for now, until I manage to fix the stable docs deployment.
| using HiGHS | ||
| using JuMP | ||
|
|
||
| system = SystemRT( |
There was a problem hiding this comment.
maybe just add a comment here on the simplifying assumption of this example
There was a problem hiding this comment.
Added a comment, does it clarify things?
No description provided.