Feature/v3/feature/308 rename effect domains (#365)

* Rename effect domains

* Rename effect domains

* Ensure backwards compatability

* Improve

* Improve

* Bugfix IO with deprectaed params

* Add guards for extra kwargs

* Add guards for extra kwargs

* centralize logic for deprectaed params

* Move handlign from centralized back to classes in a dedicated method

* Improce property handling

* Move handling to Interface class

* Getting lost

* Revert "Getting lost"

This reverts commit 3c0db76.

* Revert "Move handling to Interface class"

This reverts commit 09bdeec.

* Revert "Improce property handling"

This reverts commit 5fe2c64.

* Revert "Move handlign from centralized back to classes in a dedicated method"

This reverts commit 9f4c1f6.

* Revert "centralize logic for deprectaed params"

This reverts commit 4a82574.

* Add "" to warnings

* Revert change in examples

* Improve BackwardsCompatibleDataset

* Add unit tests for backwards compatability

* Remove backwards compatible dataset

* Renamed maximum_temporal_per_hour to maximum_per_hour and minimum_temporal_per_hour to minimum_per_hour

* Add entires to CHANGELOG.md

* Remove backwards compatible dataset

* Remove unused imports

* Move to unreleased

* Catch up on missed renamings from merge

* Catch up on missed renamings from merge

Author: FBumann

CHANGELOG.md

@@ -108,6 +108,13 @@ The weighted sum of the total objective effect of each scenario is used as the o
 * 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.
 * 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.
 * 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.
+- Renamed `Effect` parameters:
+  - `minimum_investment` → `minimum_nontemporal`
+  - `maximum_investment` → `maximum_nontemporal`
+  - `minimum_operation` → `minimum_temporal`
+  - `maximum_operation` → `maximum_temporal`
+  - `minimum_operation_per_hour` → `minimum_per_hour`
+  - `maximum_operation_per_hour` → `maximum_per_hour`
 
 
 ### 🐛 Fixed

examples/03_Calculation_types/example_calculation_types.py

@@ -207,14 +207,14 @@ def get_solutions(calcs: list, variable: str) -> xr.Dataset:
     ).write_html('results/BHKW2 Thermal Power.html')
 
     fx.plotting.with_plotly(
-        get_solutions(calculations, 'costs(operation)|total_per_timestep').to_dataframe(),
+        get_solutions(calculations, 'costs(temporal)|per_timestep').to_dataframe(),
         style='line',
         title='Operation Cost Comparison',
         ylabel='Costs [€]',
     ).write_html('results/Operation Costs.html')
 
     fx.plotting.with_plotly(
-        pd.DataFrame(get_solutions(calculations, 'costs(operation)|total_per_timestep').to_dataframe().sum()).T,
+        pd.DataFrame(get_solutions(calculations, 'costs(temporal)|per_timestep').to_dataframe().sum()).T,
         style='stacked_bar',
         title='Total Cost Comparison',
         ylabel='Costs [€]',

examples/05_Two-stage-optimization/two_stage_optimization.py

@@ -145,9 +145,9 @@
     comparison_main = comparison[
         [
             'Duration [s]',
-            'costs|total',
-            'costs(invest)|total',
-            'costs(operation)|total',
+            'costs',
+            'costs(nontemporal)',
+            'costs(temporal)',
             'BHKW2(Q_fu)|size',
             'Kessel(Q_fu)|size',
             'Speicher|size',

flixopt/calculation.py

@@ -107,8 +107,8 @@ def main_results(self) -> dict[str, Scalar | dict]:
             'Penalty': self.model.effects.penalty.total.solution.values,
             'Effects': {
                 f'{effect.label} [{effect.unit}]': {
-                    'operation': effect.submodel.operation.total.solution.values,
-                    'invest': effect.submodel.invest.total.solution.values,
+                    'temporal': effect.submodel.temporal.total.solution.values,
+                    'nontemporal': effect.submodel.nontemporal.total.solution.values,
                     'total': effect.submodel.total.solution.values,
                 }
                 for effect in self.flow_system.effects

flixopt/components.py

@@ -1056,7 +1056,7 @@ def __init__(
         prevent_simultaneous_sink_and_source = kwargs.pop('prevent_simultaneous_sink_and_source', None)
         if source is not None:
             warnings.warn(
-                'The use of the source argument is deprecated. Use the outputs argument instead.',
+                'The use of the "source" argument is deprecated. Use the "outputs" argument instead.',
                 DeprecationWarning,
                 stacklevel=2,
             )
@@ -1066,7 +1066,7 @@ def __init__(
 
         if sink is not None:
             warnings.warn(
-                'The use of the sink argument is deprecated. Use the inputs argument instead.',
+                'The use of the "sink" argument is deprecated. Use the "inputs" argument instead.',
                 DeprecationWarning,
                 stacklevel=2,
             )
@@ -1076,12 +1076,15 @@ def __init__(
 
         if prevent_simultaneous_sink_and_source is not None:
             warnings.warn(
-                'The use of the prevent_simultaneous_sink_and_source argument is deprecated. Use the prevent_simultaneous_flow_rates argument instead.',
+                'The use of the "prevent_simultaneous_sink_and_source" argument is deprecated. Use the "prevent_simultaneous_flow_rates" argument instead.',
                 DeprecationWarning,
                 stacklevel=2,
             )
             prevent_simultaneous_flow_rates = prevent_simultaneous_sink_and_source
 
+        # Validate any remaining unexpected kwargs
+        self._validate_kwargs(kwargs)
+
         super().__init__(
             label,
             inputs=inputs,
@@ -1206,14 +1209,17 @@ def __init__(
         source = kwargs.pop('source', None)
         if source is not None:
             warnings.warn(
-                'The use of the source argument is deprecated. Use the outputs argument instead.',
+                'The use of the "source" argument is deprecated. Use the "outputs" argument instead.',
                 DeprecationWarning,
                 stacklevel=2,
             )
             if outputs is not None:
                 raise ValueError('Either source or outputs can be specified, but not both.')
             outputs = [source]
 
+        # Validate any remaining unexpected kwargs
+        self._validate_kwargs(kwargs)
+
         self.prevent_simultaneous_flow_rates = prevent_simultaneous_flow_rates
         super().__init__(
             label,
@@ -1334,14 +1340,17 @@ def __init__(
         sink = kwargs.pop('sink', None)
         if sink is not None:
             warnings.warn(
-                'The use of the sink argument is deprecated. Use the inputs argument instead.',
+                'The use of the "sink" argument is deprecated. Use the "inputs" argument instead.',
                 DeprecationWarning,
                 stacklevel=2,
             )
             if inputs is not None:
                 raise ValueError('Either sink or inputs can be specified, but not both.')
             inputs = [sink]
 
+        # Validate any remaining unexpected kwargs
+        self._validate_kwargs(kwargs)
+
         self.prevent_simultaneous_flow_rates = prevent_simultaneous_flow_rates
         super().__init__(
             label,