Skip to content

Commit a79c2e0

Browse files
authored
Add release notes for v1.3.0 (#593)
* Add release notes for v1.3.0 * Add v1.3 notes to menu * Small text changes * Add note about bug fix
1 parent d21cd3f commit a79c2e0

2 files changed

Lines changed: 49 additions & 0 deletions

File tree

docs/release-notes/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ This is the list of changes to MUSE between each release.
66
.. toctree::
77
:maxdepth: 1
88

9+
v1.3.0
910
v1.2.3
1011
v1.2.2
1112
v1.2.1

docs/release-notes/v1.3.0.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Release notes for MUSE v1.3.0 (December 3, 2024)
2+
3+
## New `timeslice_level` parameter ({github}`550`)
4+
5+
- Users can now specify a timeslice level for each sector using the new `timeslice_level` parameter (for example `timeslice_level = "month"`).
6+
- This is the level of timeslice granularity over which commodity flows out of a sector are balanced with demand. For example, a user modelling an oil sector may wish to specify that oil supply must match demand on a monthly basis, but not necessarily in every hour (as oil can be stored).
7+
- See documentation for this parameter [here](https://muse-os.readthedocs.io/en/latest/inputs/toml.html#standard-sectors). More details can also be found at {github}`550`.
8+
- Note: This supersedes the timeslice aggregation feature in previous versions of MUSE. If you have a `timeslices.aggregates` section in your settings file, this should be deleted, otherwise a warning will be raised.
9+
10+
## Default solver ({github}`587`)
11+
12+
- The default solver has changed to "scipy" (previously "adhoc")
13+
- If the `lpsolver` field is left blank for any subsector, a warning will be raised and "scipy" will be used. If you wish to use the "adhoc" solver, you __must__ specify `lpsolver = "adhoc"`.
14+
- Users are encouraged to use the "scipy" solver for all subsectors, unless memory limits are reached (see {github}`389`)
15+
16+
## Added support for Python 3.13 ({github}`564`)
17+
18+
- MUSE now works with Python versions 3.9 to 3.13
19+
- Python 3.9 reaches its end of life [next year](https://devguide.python.org/versions/), so if you are currently using Python 3.9, now is a good opportunity to upgrade
20+
21+
## Bug fixes
22+
23+
- A major error with the "comfort", "efficiency", "capital_costs" and "ALCOE" objectives has been fixed ({github}`581`).
24+
- Processing of the `AgentShare` parameter (agents file and technodata files) has changed to enforce consistency between files ({github}`586`). If you receive a new `AgentShareNotDefined` error, please double check that your `AgentShare` names are consistent between your agents and techodata files. See updated documentation [here](https://muse-os.readthedocs.io/en/latest/inputs/technodata.html).
25+
26+
## Deprecated features
27+
28+
### Outputs ({github}`548`)
29+
30+
- The following outputs have been deleted and can no longer be used: "timeslice_supply", "metric_supply", "yearly_supply", "metricy_supply", "timeslice_consumption", "metric_consumption", "yearly_consumption", "metricy_consumption"
31+
- Any attempt to use these outputs will raise an error
32+
- If you need detailed supply/consumption data for any sector, please use the "supply" and "consumption" outputs within each sector, for example (replacing `SECTOR_NAME` with the name of the sector):
33+
34+
```toml
35+
[[sectors.SECTOR_NAME.outputs]]
36+
filename = '{cwd}/{default_output_dir}/{Sector}/{Quantity}.csv'
37+
quantity = "supply"
38+
sink = "aggregate"
39+
```
40+
41+
### Production methods ({github}`557` and {github}`559`)
42+
43+
- The "match" and "costed" options for the `dispatch_production` parameter have been removed
44+
- Please see [here](https://muse-os.readthedocs.io/en/latest/inputs/toml.html#standard-sectors) for updated documentation on this parameter
45+
46+
### Legacy sectors ({github}`510`)
47+
48+
- Sectors with `type = "legacy"` are no longer compatible

0 commit comments

Comments
 (0)