Operating cost documentation updates

NREL-Sienna / PowerSystems.jl

Data structures in Julia to enable power systems analysis. Part of the Scalable Integrated Infrastructure Planning Initiative at the National Renewable Energy Lab.

https://www.nrel.gov/analysis/sienna.html

BSD 3-Clause "New" or "Revised" License

299 stars 71 forks source link

Operating cost documentation updates #1120

Closed kdayday closed 1 week ago

kdayday commented 3 weeks ago

Branch for cost documentation updates (documentation only, no changes to struct fields)

There are changes to OperationalCost getter/setters where they were either missing or the docstring was wrong
OperationalCost getter/setters are exported where they were missing
Add operating cost how-to
Also bug fixes pictures in the documentation weren't showing up due to pointing to wrong location
Couple other minor docstring bug fixes outside costs

kdayday commented 2 weeks ago

Outstanding items:

@GabrielKS 's updates to the cost table including graphics of each operating cost
(me and @GabrielKS) Moving the ValueCurve and FuelCurve/CostCurve structs up a level in the Model Library so each has its own page and all getter/setters visible

@jd-lara @rodrigomha In case I'm out sick later this week, I think it would be beneficial to merge this branch before releasing PSY4 even if those items^ aren't resolved yet.

GabrielKS commented 1 week ago

@jd-lara @rodrigomha In case I'm out sick later this week, I think it would be beneficial to merge this branch before releasing PSY4 even if those items^ aren't resolved yet.

Agreed — especially since given recent conversations with @jd-lara @rodrigomha I'll be modifying the cost structs themselves a bit, can we get this reviewed and merged now and then I'll add my documentation pieces on a subsequent PR?