Release guide for v1.2.1

[tsmbland]

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 (Fix bugs in the carbon budget bisection algorithm #483, Improvements to carbon_budget module #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

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 (Use aggregate sink for all example models #461)

Tutorials

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