v1.3.3

https://muse-os.readthedocs.io/en/latest/release-notes/v1.3.3.html

v1.3.2

https://muse-os.readthedocs.io/en/latest/release-notes/v1.3.2.html

v1.3.1

https://muse-os.readthedocs.io/en/latest/release-notes/v1.3.1.html

v1.3.0

Merge pull request #554 from EnergySystemsModellingLab/v1.3

MUSE version 1.3.0

v1.2.4rc1

Merge branch 'main' into objective_dimensions

v1.2.3

November 19, 2024

Installation

If you have previously installed MUSE within a virtual environment, you can update MUSE by activating your virtual environment and running pip install --upgrade muse-os

If you installed MUSE using a different method, please consult the documentation.

Changes

Log files (#560)

• MUSE will now output two log files to the results folder whenever a simulation is run: one (muse_info.log) containing info and debug messages, and the other (muse_warning.log) containing warning messages.
• Users are particularly encouraged to consult the muse_warnings.log file after each run, and pay attention to any messages shown.

MaxCapacityGrowth parameter (#565)

• The definition of this parameter has changed to compound growth rather than linear growth. It can now be properly interpreted as the maximum growth of the technology per year. See the documentation for this parameter here
• To give an example, if a 5 year time period is being used, a value of 0.5 previously meant that capacity was allowed to grow by 250% over the time period (0.5 * 5 * 100), but with compound growth the limit is now 660% (((1.5 ** 5) - 1) * 100)
• Users may see results change as a result of this.

Material and Variable costs (#563)

• Fixes errors in the calculation of material and variable costs, particularly in the case of technologies with output quantities not equal to 1. See #563 for details
• This effects decision metrics, but doesn't directly effect commodity prices. There are known issues remaining in the calculation of commodity prices (#551, #552), which will be fixed separately

Minor bug fixes

• Fixed an error introduced in v1.2.1 which caused carbon budget simulations to fail if no method options were specified (#539)

v1.2.2

October 28, 2024

Installation

If you have previously installed MUSE within a virtual environment, you can update MUSE by activating your virtual environment and running pip install --upgrade muse-os

If you installed MUSE using a different method, please consult the documentation.

Changes

Bug fixes

This release fixes several errors in calculations related to the utilization factor, minimum service factor and commodity prices. Interested readers can follow the discussions in the following pull requests:

• #368
• #518
• #534

Developers should pay particular attention to the latter two PRs, to avoid introducing similar mistakes in the future.

v1.2.2rc1

This release fixes several bugs related to the utilization factor, minimum service factor and the use of timeslices, which were affecting supply outputs and investment decisions. Most models are likely to be affected in some way by these fixes, although for many models these effects will be small. Models using the minimum service factor, and models with timeslice-level constraints (minimum service factor and utilization factor) are most likely to be strongly effected. Interested readers can follow the discussions in #518 and #368

v1.2.1

The following guide should be read by all users upgrading from v1.2.0. Please read through carefully, as some of the changes may require you to modify your model input files or downstream analysis scripts.

Installation

If you have previously installed MUSE within a virtual environment, you can update MUSE by activating your virtual environment and running pip install --upgrade muse-os

If you installed MUSE using a different method, please consult the documentation.

Changes

Carbon budget module

• The bisection method has been fixed, as this was not working as expected before (#483, #484). Additionally, a number of default settings have been changed, and parameters renamed. Users must carefully check which parameters are specified in their settings files, as any unspecified parameters will revert to the new defaults. The main changes are as follows:
  • control_undershoot / control_overshoot: The default has been changed from True to False
  • method: The default has changed from fitting to bisection
  • method_options.refine_price: The default has changed from True to False
  • method_options.resolution: New parameter
  • method_options.sample_size: This parameter no longer applies to the bisection algorithm, and won't be permitted when using that method. Please use method_options.max_iterations instead
  • method_options.tolerance and method_options.early_termination_count: New parameters for the bisection method

Please read the new documentation page in full before using a carbon budget

Edit 20/10/24: MUSE will throw an error if no method_options are specified in the toml file (i.e. if you want to use the default option for all parameters). This is a known bug which will be fixed in v1.2.3, but for now please make that at least one method_option parameter is specified in the toml file (e.g. method_options.max_iterations = 5), or explicitly build an empty dictionary by including the following line: [carbon_budget_control.method_options]

Default model

• A number of changes have been made to the default model that is generated with muse --model default --copy PATH. This is mostly to simplify the outputs (#461)

Tutorials

• The tutorials have been simplified and re-ordered (#470)
• A tutorial has been added explaining the use of a carbon budget (#486)

v1.2.1rc1

The following guide should be read by all users upgrading from v1.2.0. Please read through carefully, as some of the changes may require you to modify your model input files or downstream analysis scripts.

Installation

If you have previously installed MUSE within a virtual environment, you can update MUSE by activating your virtual environment and running pip install --upgrade muse-os --pre

The --pre option is required as v1.2.1 is currently a pre-release.

If you installed MUSE using a different method, please consult the documentation.

Changes

Carbon budget module

• The bisection method has been fixed, as this was not working as expected before (#483, #484). Additionally, a number of default settings have been changed, and parameters renamed. Users must carefully check which parameters are specified in their settings files, as any unspecified parameters will revert to the new defaults. The main changes are as follows:
  • control_undershoot / control_overshoot: The default has been changed from True to False
  • method: The default has changed from fitting to bisection
  • method_options.refine_price: The default has changed from True to False
  • method_options.sample_size: This parameter no longer applies to the bisection algorithm, and won't be permitted when using that method. Please use method_options.max_iterations instead
  • method_options.tolerance and method_options.early_termination_count: New parameters for the bisection method

Please read the new documentation page in full before using a carbon budget

Default model

• A number of changes have been made to the default model that is generated with muse --model default --copy PATH. This is mostly to have a simpler model with a reduced set of output files (#461)

Tutorials

• The tutorials have been simplified and re-ordered (#470)
• A tutorial has been added explaining the use of a carbon budget (#486)