V3.0.0/invest

flixopt/__init__.py

@@ -16,6 +16,7 @@
     FlowSystem,
     FullCalculation,
     InvestParameters,
+    InvestTimingParameters,
     LinearConverter,
     OnOffParameters,
     Piece,

flixopt/calculation.py

@@ -28,7 +28,7 @@
 from .config import CONFIG
 from .core import DataConverter, Scalar, TimeSeriesData, drop_constant_arrays
 from .elements import Component
-from .features import InvestmentModel
+from .features import InvestmentModel, InvestmentTimingModel
 from .flow_system import FlowSystem
 from .results import CalculationResults, SegmentedCalculationResults
 from .solvers import _Solver
@@ -113,13 +113,15 @@ def main_results(self) -> Dict[str, Union[Scalar, Dict]]:
                     model.label_of_element: model.size.solution
                     for component in self.flow_system.components.values()
                     for model in component.submodel.all_submodels
-                    if isinstance(model, InvestmentModel) and model.size.solution.max() >= CONFIG.modeling.EPSILON
+                    if isinstance(model, (InvestmentModel, InvestmentTimingModel))
+                    and model.size.solution.max() >= CONFIG.modeling.EPSILON
                 },
                 'Not invested': {
                     model.label_of_element: model.size.solution
                     for component in self.flow_system.components.values()
                     for model in component.submodel.all_submodels
-                    if isinstance(model, InvestmentModel) and model.size.solution.max() < CONFIG.modeling.EPSILON
+                    if isinstance(model, (InvestmentModel, InvestmentTimingModel))
+                    and model.size.solution.max() < CONFIG.modeling.EPSILON
                 },
             },
             'Buses with excess': [

flixopt/commons.py

@@ -18,7 +18,15 @@
 from .effects import Effect
 from .elements import Bus, Flow
 from .flow_system import FlowSystem
-from .interface import InvestParameters, OnOffParameters, Piece, Piecewise, PiecewiseConversion, PiecewiseEffects
+from .interface import (
+    InvestParameters,
+    InvestTimingParameters,
+    OnOffParameters,
+    Piece,
+    Piecewise,
+    PiecewiseConversion,
+    PiecewiseEffects,
+)
 
 __all__ = [
     'TimeSeriesData',
@@ -48,4 +56,5 @@
     'results',
     'linear_converters',
     'solvers',
+    'InvestTimingParameters',
 ]

flixopt/components.py

@@ -94,7 +94,7 @@ def _plausibility_checks(self) -> None:
                         f'(in {self.label_full}) and variable size is uncommon. Please check if this is intended!'
                     )
 
-    def transform_data(self, flow_system: 'FlowSystem'):
+    def transform_data(self, flow_system: 'FlowSystem', name_prefix: str = '') -> None:
         super().transform_data(flow_system)
         if self.conversion_factors:
             self.conversion_factors = self._transform_conversion_factors(flow_system)
@@ -207,7 +207,7 @@ def create_model(self, model: FlowSystemModel) -> 'StorageModel':
         self.submodel = StorageModel(model, self)
         return self.submodel
 
-    def transform_data(self, flow_system: 'FlowSystem') -> None:
+    def transform_data(self, flow_system: 'FlowSystem', name_prefix: str = '') -> None:
         super().transform_data(flow_system)
         self.relative_minimum_charge_state = flow_system.fit_to_model_coords(
             f'{self.label_full}|relative_minimum_charge_state',
@@ -393,7 +393,7 @@ def create_model(self, model) -> 'TransmissionModel':
         self.submodel = TransmissionModel(model, self)
         return self.submodel
 
-    def transform_data(self, flow_system: 'FlowSystem') -> None:
+    def transform_data(self, flow_system: 'FlowSystem', name_prefix: str = '') -> None:
         super().transform_data(flow_system)
         self.relative_losses = flow_system.fit_to_model_coords(
             f'{self.label_full}|relative_losses', self.relative_losses

flixopt/effects.py

@@ -13,7 +13,7 @@
 import numpy as np
 import xarray as xr
 
-from .core import Scalar, TemporalData, TemporalDataUser
+from .core import NonTemporalDataUser, Scalar, TemporalData, TemporalDataUser
 from .features import ShareAllocationModel
 from .structure import Element, ElementModel, FlowSystemModel, Interface, Submodel, register_class_for_io
 
@@ -192,7 +192,7 @@ def _do_modeling(self):
 TemporalEffectsUser = Union[TemporalDataUser, Dict[str, TemporalDataUser]]  # User-specified Shares to Effects
 """ This datatype is used to define a temporal share to an effect by a certain attribute. """
 
-NonTemporalEffectsUser = Union[Scalar, Dict[str, Scalar]]  # User-specified Shares to Effects
+NonTemporalEffectsUser = Union[NonTemporalDataUser, Dict[str, NonTemporalDataUser]]  # User-specified Shares to Effects
 """ This datatype is used to define a scalar share to an effect by a certain attribute. """
 
 TemporalEffects = Dict[str, TemporalData]  # User-specified Shares to Effects

flixopt/elements.py

@@ -13,8 +13,8 @@
 from .config import CONFIG
 from .core import PlausibilityError, Scalar, TemporalData, TemporalDataUser
 from .effects import TemporalEffectsUser
-from .features import InvestmentModel, ModelingPrimitives, OnOffModel
-from .interface import InvestParameters, OnOffParameters
+from .features import InvestmentModel, InvestmentTimingModel, ModelingPrimitives, OnOffModel
+from .interface import InvestParameters, InvestTimingParameters, OnOffParameters
 from .modeling import BoundingPatterns, ModelingUtilitiesAbstract
 from .structure import Element, ElementModel, FlowSystemModel, register_class_for_io
 
@@ -70,7 +70,7 @@ def create_model(self, model: FlowSystemModel) -> 'ComponentModel':
         self.submodel = ComponentModel(model, self)
         return self.submodel
 
-    def transform_data(self, flow_system: 'FlowSystem') -> None:
+    def transform_data(self, flow_system: 'FlowSystem', name_prefix: str = '') -> None:
         if self.on_off_parameters is not None:
             self.on_off_parameters.transform_data(flow_system, self.label_full)
 
@@ -118,7 +118,7 @@ def create_model(self, model: FlowSystemModel) -> 'BusModel':
         self.submodel = BusModel(model, self)
         return self.submodel
 
-    def transform_data(self, flow_system: 'FlowSystem'):
+    def transform_data(self, flow_system: 'FlowSystem', name_prefix: str = '') -> None:
         self.excess_penalty_per_flow_hour = flow_system.fit_to_model_coords(
             f'{self.label_full}|excess_penalty_per_flow_hour', self.excess_penalty_per_flow_hour
         )
@@ -158,7 +158,7 @@ def __init__(
         self,
         label: str,
         bus: str,
-        size: Union[Scalar, InvestParameters] = None,
+        size: Union[Scalar, InvestParameters, InvestTimingParameters] = None,
         fixed_relative_profile: Optional[TemporalDataUser] = None,
         relative_minimum: TemporalDataUser = 0,
         relative_maximum: TemporalDataUser = 1,
@@ -238,7 +238,7 @@ def create_model(self, model: FlowSystemModel) -> 'FlowModel':
         self.submodel = FlowModel(model, self)
         return self.submodel
 
-    def transform_data(self, flow_system: 'FlowSystem'):
+    def transform_data(self, flow_system: 'FlowSystem', name_prefix: str = '') -> None:
         self.relative_minimum = flow_system.fit_to_model_coords(
             f'{self.label_full}|relative_minimum', self.relative_minimum
         )
@@ -266,7 +266,7 @@ def transform_data(self, flow_system: 'FlowSystem'):
 
         if self.on_off_parameters is not None:
             self.on_off_parameters.transform_data(flow_system, self.label_full)
-        if isinstance(self.size, InvestParameters):
+        if isinstance(self.size, (InvestParameters, InvestTimingParameters)):
             self.size.transform_data(flow_system, self.label_full)
         else:
             self.size = flow_system.fit_to_model_coords(f'{self.label_full}|size', self.size, dims=['year', 'scenario'])
@@ -276,7 +276,7 @@ def _plausibility_checks(self) -> None:
         if np.any(self.relative_minimum > self.relative_maximum):
             raise PlausibilityError(self.label_full + ': Take care, that relative_minimum <= relative_maximum!')
 
-        if not isinstance(self.size, InvestParameters) and (
+        if not isinstance(self.size, (InvestParameters, InvestTimingParameters)) and (
             np.any(self.size == CONFIG.modeling.BIG) and self.fixed_relative_profile is not None
         ):  # Default Size --> Most likely by accident
             logger.warning(
@@ -377,15 +377,28 @@ def _create_on_off_model(self):
         )
 
     def _create_investment_model(self):
-        self.add_submodels(
-            InvestmentModel(
-                model=self._model,
-                label_of_element=self.label_of_element,
-                parameters=self.element.size,
-                label_of_model=self.label_of_element,
-            ),
-            'investment',
-        )
+        if isinstance(self.element.size, InvestParameters):
+            self.add_submodels(
+                InvestmentModel(
+                    model=self._model,
+                    label_of_element=self.label_of_element,
+                    parameters=self.element.size,
+                    label_of_model=self.label_of_element,
+                ),
+                'investment',
+            )
+        elif isinstance(self.element.size, InvestTimingParameters):
+            self.add_submodels(
+                InvestmentTimingModel(
+                    model=self._model,
+                    label_of_element=self.label_of_element,
+                    parameters=self.element.size,
+                    label_of_model=self.label_of_element,
+                ),
+                'investment',
+            )
+        else:
+            raise ValueError(f'Invalid InvestParameters type: {type(self.element.size)}')
 
     def _constraint_flow_rate(self):
         if not self.with_investment and not self.with_on_off:
@@ -435,7 +448,7 @@ def with_on_off(self) -> bool:
 
     @property
     def with_investment(self) -> bool:
-        return isinstance(self.element.size, InvestParameters)
+        return isinstance(self.element.size, (InvestParameters, InvestTimingParameters))
 
     # Properties for clean access to variables
     @property
@@ -508,7 +521,7 @@ def absolute_flow_rate_bounds(self) -> Tuple[TemporalData, TemporalData]:
             if not self.with_investment:
                 # Basic case without investment and without OnOff
                 lb = lb_relative * self.element.size
-            elif not self.element.size.optional:
+            elif isinstance(self.element.size, InvestParameters) and not self.element.size.optional:
                 # With non-optional Investment
                 lb = lb_relative * self.element.size.minimum_or_fixed_size