Sienna-Platform / Sienna-Platform/PowerOperationsModels.jl
Update and correct `FunctionData` section in formulation library
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Julia
- Stars
- 2
- Forks
- 1
- Avg merge
- 1d 16h
- Merged PRs (30d)
- 26
Description
The FunctionData Options section of the formulation library is out of date/incorrect in several respects:
-
PolynomialFunctionDatadoes not exist. It did at one point during the prototyping of the new cost structs, but no longer. - I don't think we should really be talking about
FunctionDataat all. The current design has users only ever operating at theValueCurvelevel and above. Instead, I think we should take the PSYValueCurvetable (plus the special case ofMarketBidCost?) and document how each of those is represented in the optimization problem. - Looks like there's a Markdown formatting error.
- How does
FunctionDataOptions relate to this other costs page?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Compare the formulation library's FunctionData Options and Piecewise costs pages with the PowerSystems ValueCurve options table. First identify the outdated FunctionData entries, the Markdown formatting error, and any overlap between the two pages; done means the documentation reflects current ValueCurve-level usage, covers the MarketBidCost special case if applicable, and explains the relationship between the pages.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100