New objective functions and documentation

arfc / osier

Justice oriented energy system optimization framework

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

6 stars 7 forks source link

New objective functions and documentation #39

Closed samgdotson closed 1 year ago

samgdotson commented 1 year ago

Please review PR #38 before reviewing this one!

Updates

This PR adds several things

generic objectives (e.g., per_unit_energy or per_unit_capacity)
a new objective that measures volatility
documentation for these objectives and examples for their use
tests for these objectives

and it updates the capacity_expansion module to account for generic objectives.

samgdotson commented 1 year ago

Thanks for the review @abachma2. There might be some repetition since I was working on this and the previous PR simultaneously. Fortunately there are no code conflicts (per github). I pulled in the previous merge so it should be okay.

samgdotson commented 1 year ago

Thanks for the review @LukeSeifert, if you're satisfied you can go ahead and merge. I updated the doc string to reflect the change in the default value.

samgdotson commented 1 year ago

@abachma2 @LukeSeifert @yardasol @munkm I renamed the two ambiguous functions objective_from_X. Hopefully, this satisfies everyone. I also added equations to the docstrings.

samgdotson commented 1 year ago

Nudge @abachma2 @yardasol