Skip to content

Commit 552569a

Browse files
authored
Fix/update migration guide and changelog (#411)
* Fix Docs * Update Changelog and migration guide for missing breaking changes * Update Migration guide * Improve * Use tabs in mkdocs * Update varaibel renaming * Update variable renaming * From main * Update * Update * Update * Add links * Add emojis * compact 2 * Enable plugin * Update * Update * Update CHangelog.md
1 parent 8294a64 commit 552569a

3 files changed

Lines changed: 183 additions & 473 deletions

File tree

CHANGELOG.md

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,8 @@ Please keep the format of the changelog consistent with the other releases, so t
6161
### 📦 Dependencies
6262
6363
### 📝 Docs
64+
- Updated Migration Guide and added missing entries.
65+
- Improved Changelog of v3.0.0
6466
6567
### 👷 Development
6668
@@ -139,17 +141,43 @@ This replaces `specific_share_to_other_effects_*` parameters and inverts the dir
139141

140142
### 💥 Breaking Changes
141143

142-
- `relative_minimum_charge_state` and `relative_maximum_charge_state` don't have an extra timestep anymore.
144+
**API and Behavior Changes:**
145+
146+
- **Effect system redesigned** (no deprecation):
147+
- **Terminology changes**: Effect domains renamed for clarity: `operation``temporal`, `invest`/`investment``periodic`
148+
- **Sharing system**: The old `specific_share_to_other_effects_*` parameters were completely replaced with the new `share_from_temporal` and `share_from_periodic` syntax (see 🔥 Removed section)
149+
- **FlowSystem independence**: FlowSystems cannot be shared across multiple Calculations anymore. A copy of the FlowSystem is created instead, making every Calculation independent. Each Subcalculation in `SegmentedCalculation` now has its own distinct `FlowSystem` object
150+
- **Bus and Effect object assignment**: Direct assignment of Bus/Effect objects is no longer supported. Use labels (strings) instead:
151+
- `Flow.bus` must receive a string label, not a Bus object
152+
- Effect shares must use effect labels (strings) in dictionaries, not Effect objects
153+
- **Logging defaults** (from v2.2.0): Console and file logging are now disabled by default. Enable explicitly with `CONFIG.Logging.console = True` and `CONFIG.apply()`
154+
155+
**Class and Method Renaming:**
156+
143157
- Renamed class `SystemModel` to `FlowSystemModel`
144158
- Renamed class `Model` to `Submodel`
145159
- Renamed `mode` parameter in plotting methods to `style`
146-
- Renamed investment binary variable `is_invested` to `invested` in `InvestmentModel`
147-
- `Calculation.do_modeling()` now returns the `Calculation` object instead of its `linopy.Model`. Callers that previously accessed the linopy model directly should now use `calculation.do_modeling().model` instead of `calculation.do_modeling()`.
160+
- `Calculation.do_modeling()` now returns the `Calculation` object instead of its `linopy.Model`. Callers that previously accessed the linopy model directly should now use `calculation.do_modeling().model` instead of `calculation.do_modeling()`
161+
162+
**Variable Renaming in Results:**
163+
164+
- Investment binary variable: `is_invested``invested` in `InvestmentModel`
165+
- Switch tracking variables in `OnOffModel`:
166+
- `switch_on``switch|on`
167+
- `switch_off``switch|off`
168+
- `switch_on_nr``switch|count`
169+
- Effect submodel variables (following terminology changes):
170+
- `Effect(invest)|total``Effect(periodic)`
171+
- `Effect(operation)|total``Effect(temporal)`
172+
- `Effect(operation)|total_per_timestep``Effect(temporal)|per_timestep`
173+
- `Effect|total``Effect`
174+
175+
**Data Structure Changes:**
176+
177+
- `relative_minimum_charge_state` and `relative_maximum_charge_state` don't have an extra timestep anymore. Use the new `relative_minimum_final_charge_state` and `relative_maximum_final_charge_state` parameters for final state control
148178

149179
### ♻️ Changed
150180

151-
- FlowSystems cannot be shared across multiple Calculations anymore. A copy of the FlowSystem is created instead, making every Calculation independent
152-
- Each Subcalculation in `SegmentedCalculation` now has its own distinct `FlowSystem` object
153181
- Type system overhaul - added clear separation between temporal and non-temporal data throughout codebase for better clarity
154182
- Enhanced FlowSystem interface with improved `__repr__()` and `__str__()` methods
155183
- Improved Model Structure - Views and organisation is now divided into:
@@ -164,8 +192,6 @@ This replaces `specific_share_to_other_effects_*` parameters and inverts the dir
164192

165193
- The `agg_group` and `agg_weight` parameters of `TimeSeriesData` are deprecated and will be removed in a future version. Use `aggregation_group` and `aggregation_weight` instead.
166194
- The `active_timesteps` parameter of `Calculation` is deprecated and will be removed in a future version. Use the new `sel(time=...)` method on the FlowSystem instead.
167-
- The assignment of Bus Objects to Flow.bus is deprecated and will be removed in a future version. Use the label of the Bus instead.
168-
- The usage of Effects objects in Dicts to assign shares to Effects is deprecated and will be removed in a future version. Use the label of the Effect instead.
169195
- **InvestParameters** parameters renamed for improved clarity around investment and retirement effects:
170196
- `fix_effects``effects_of_investment`
171197
- `specific_effects``effects_of_investment_per_size`

0 commit comments

Comments
 (0)