diff --git a/CHANGELOG.md b/CHANGELOG.md index dcfb707..0f42feb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,38 +1,42 @@ # Changelog -## [0.2.0] - [Unreleased] +All notable changes to this project will be documented in this file. +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [0.2.0] - 2021-05-28 ### Added - -- Sub-hourly unit commitment -- Added function `UnitCommitment.write(filename, solution)` -- Added mathematical formulation to the documentation +- Add sub-hourly unit commitment +- Add `UnitCommitment.write(filename, solution)` +- Add mathematical formulation to the documentation ### Changed - -- Renamed "Time (h)" parameter to "Time horizon (h)" +- Rename "Time (h)" parameter to "Time horizon (h)" +- Rename `UnitCommitment.get_solution` to `UnitCommitment.solution`, for better + consistency with JuMP style. +- Add an underscore to the name of all functions that do not appear in the + documentation (e.g. `something` becomes `_something`) These functions are not + part of the public API and may change without notice, even in patch versions. - The function `UnitCommitment.build_model` now returns a plain JuMP model. The - struct `UnitCommitmentModel` has been completely removed. Accessing model elements can now be accomplished as follows: + struct `UnitCommitmentModel` has been completely removed. Accessing model + elements can now be accomplished as follows: - `model.vars.x[idx]` becomes `model[:x][idx]` - `model.eqs.y[idx]` becomes `model[:eq_y][idx]` - `model.expr.z[idx]` becomes `model[:expr_z][idx]` - `model.obj` becomes `model[:obj]` - `model.isf` becomes `model[:isf]` - `model.lodf` becomes `model[:lodf]` -- The function `UnitCommitment.get_solution` has been renamed to `UnitCommitment.solution` -- All function that do not appear in the documentation have been renamed to `_something`. - These functions are not part of the public API and may change without notice. ### Fixed - -- Properly validate solutions with price-sensitive loads. +- Properly validate solutions with price-sensitive loads ## [0.1.1] - 2020-11-16 +### Added +- Add OR-LIB and Tejada19 instances +- Improve documentation -* Fixes to MATLAB and PGLIB-UC instances -* Add OR-LIB and Tejada19 instances -* Improve documentation +## Fixed +- Fixes to MATLAB and PGLIB-UC instances ## [0.1.0] - 2020-11-06 - -* Initial public release +- Initial public release