Release Notes

Upcoming Release

New Features and Major Changes

Minor Changes and Bug Fixes

Version v0.0.9

Upcoming Release

New Features and Major Changes

• Add HydroSystemsUnitBlock #97
• Support python 3.10+: move from os.set_blocking to queue + threading for non-blocking subprocess output PR #95

Minor Changes and Bug Fixes

• Enable logging in template gurobi #96

Version v0.0.8

New Features and Major Changes

• Add draft config for SDDPBlock PR #93

Minor Changes and Bug Fixes

• Add architecture to documentation PR #94

Version v0.0.7

Minor Changes and Bug Fixes

• Include and update BSCfg and BSPar for InvestmentBlock commit #8afcf45

Version v0.0.6

New Features and Major Changes

• Add quantities for time-variant quantities of DCNetworkBlock PR #91

Version v0.0.5

New Features and Major Changes

• Introduce StandingBatteryRho commit #6bed141

Version v0.0.4

New Features and Major Changes

• Provide InvestmentBlockSolver and InvestmentSolver PR #87

Minor Changes and Bug Fixes

• Enhance block support for block.add commit #9e5106d
• Improved Unit commitment parameters for ThermalUnitBlock, correct LineName in UCBlock PR #88
• Include MaxGeneration and MinGeneration for IntermittentUnitBlock PR #89

Version v0.0.3

New Features and Major Changes

• Introduce example on input/output operations and introduce solution object into the example PR #80
• Revise SMSPPSolverTool.is_available to support shell option and move shell option to constructor of SMSPPSolverTool PR #78
• Enable shell option in SMSNetwork.optimize PR #77
• Enable shell option in subprocess of tools and generalize options: add explicit solverconfig option and kwargs to generalize options PR #73
• Generalize solver_log PR #72
• Convert documentation from Sphinx/RST to MkDocs PR #68
• Add plot() methods to Variable and Block PR #66
• Enable functional building of a TSSB block with test PR #64
• Add TSSB solver PR #58
• Enable creation of general blocks PR #54
• Implement Attribute and Dimension as first-class objects PR #51
• Add TSSB Block structure creation PR #49
• Add block tree visualization utility PR #39
• Add is_smspp_installed() to check SMS++ installation PR #41

Minor Changes and Bug Fixes

• Revise tssb definition PR #83
• Add NodeName and LineName to UCBlock, name to UnitBlocks PR #81
• Add show_all to print_tree commit a8127da
• Improve print_tree: add counts and drop brackets when block_type is missing PR #45
• Improve docstrings and package-level documentation PR #47
• Clean smspp tools options PR #48
• Rename parse_ucblock_solver_log into parse_solver_log PR #55
• Remove sequential dependency between SMS++ test jobs PR #57
• Enable empty block_type on Block construction PR #63
• Use conda package smspp-project for ReadTheDocs builds PR #43
• Fixed test.yml for macOS PR #38

Version v0.0.2

New Features and Major Changes

• Block constructor PR #5
• Added DesignNetworkBlock PR #29
• UC/Investment configs + IntermittentUnitBlock updates PR #27
• Add hyperarcs PR #21
• Add Solution object PR #12
• Add result.solution PR #16
• Move to highs as default for InvestmentBlock PR #15
• Enable online logging and resource tracking PR #31

Minor Changes and Bug Fixes

• Add SMS++ installation to CI PR #6
• Add SMS++ in readthedocs workflow PR #9
• Test windows in CI PR #10
• Avoid use of match PR #19
• Update creation of path in windows PR #32
• Fix CI PR #28

Version v0.0.1 - Initial Release

New Features and Major Changes

• Prototype definition of Attribute, Variable, Block, and SMSNetwork classes.
• Initial implementation of SMSPPSolverTool for UCBlock and InvestmentBlock.
• Documentation with Sphinx and ReadTheDocs.
• Implementation of proper CI with GitHub Actions, including testing on Linux, Windows, and macOS.

Release Process

• Checkout a new release branch git checkout -b release-v0.x.x.
• Finalise release notes at docs/release_notes.md.
• Update version number in pyproject.toml.
• Open, review, and merge pull request for branch release-v0.x.x. Make sure to close issues and PRs or the release milestone with it (e.g. closes #X). Run pre-commit run --all-files locally and fix any issues.
• Update and checkout your local main and tag a release with git tag v0.x.x, git push, git push --tags. Include release notes in the tag message using the GitHub UI.