flixopt 2.1.4__tar.gz → 2.1.6__tar.gz

{flixopt-2.1.4 → flixopt-2.1.6}/.github/workflows/python-app.yaml

@@ -200,6 +200,11 @@ jobs:
         with:
           python-version: "3.11"
 
+      - name: Sync changelog to docs
+        run: |
+          cp CHANGELOG.md docs/changelog.md
+          echo "✅ Synced changelog to docs"
+
       - name: Install documentation dependencies
         run: |
           python -m pip install --upgrade pip

{flixopt-2.1.4 → flixopt-2.1.6}/CHANGELOG.md

@@ -7,6 +7,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+
+## [2.1.6] - 2025-09-02
+
+### Changed
+- `Sink`, `Source` and `SourceAndSink` now accept multiple `flows` as `inputs` and `outputs` instead of just one. This enables to model more use cases using these classes. [[#291](https://github.com/flixOpt/flixopt/pull/291) by [@FBumann](https://github.com/FBumann)]
+- Further, both `Sink` and `Source` now have a `prevent_simultaneous_flow_rates` argument to prevent simultaneous flow rates of more than one of their Flows. [[#291](https://github.com/flixOpt/flixopt/pull/291) by [@FBumann](https://github.com/FBumann)]
+
+### Added
+- Added `FlowSystem.start_network_app()` and `FlowSystem.stop_network_app()` to easily visualize the network structure of a flow system in an interactive dash web app. This is still experimental and might change in the future. [[#293](https://github.com/flixOpt/flixopt/pull/293) by [@FBumann](https://github.com/FBumann)]
+
+### Deprecated
+- For the classes `Sink`, `Source` and `SourceAndSink`: `.sink`, `.source` and `.prevent_simultaneous_sink_and_source` are deprecated in favor of the new arguments `inputs`, `outputs` and `prevent_simultaneous_flow_rates`. [[#291](https://github.com/flixOpt/flixopt/pull/291) by [@FBumann](https://github.com/FBumann)]
+
+### Fixed
+- Fixed testing issue with new `linopy` version 0.5.6 [[#296](https://github.com/flixOpt/flixopt/pull/296) by [@FBumann](https://github.com/FBumann)]
+
+## [2.1.5] - 2025-07-08
+
+### Fixed
+- Fixed Docs deployment
+
 ## [2.1.4] - 2025-07-08
 
 ### Fixed

{flixopt-2.1.4 → flixopt-2.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flixopt
-Version: 2.1.4
+Version: 2.1.6
 Summary: Vector based energy and material flow optimization framework in Python.
 Author-email: "Chair of Building Energy Systems and Heat Supply, TU Dresden" <peter.stange@tu-dresden.de>, Felix Bumann <felixbumann387@gmail.com>, Felix Panitz <baumbude@googlemail.com>, Peter Stange <peter.stange@tu-dresden.de>
 Maintainer-email: Felix Bumann <felixbumann387@gmail.com>, Peter Stange <peter.stange@tu-dresden.de>
@@ -18,13 +18,12 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Science/Research
 Classifier: Topic :: Scientific/Engineering
-Classifier: License :: OSI Approved :: MIT License
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: numpy<3,>=1.21.5
 Requires-Dist: pandas<3,>=2.0.0
-Requires-Dist: linopy<0.6.0,>=0.5.1
+Requires-Dist: linopy<0.5.6,>=0.5.1
 Requires-Dist: netcdf4<2,>=1.6.1
 Requires-Dist: PyYAML<7,>=6.0.0
 Requires-Dist: rich>=13.0.0
@@ -32,6 +31,22 @@ Requires-Dist: tomli>=2.0.1; python_version < "3.11"
 Requires-Dist: highspy>=1.5.3
 Requires-Dist: matplotlib<4.0.0,>=3.5.2
 Requires-Dist: plotly<6.0.0,>=5.15.0
+Provides-Extra: network-viz
+Requires-Dist: dash>=3.0.0; extra == "network-viz"
+Requires-Dist: dash-cytoscape>=1.0.0; extra == "network-viz"
+Requires-Dist: dash-daq>=0.6.0; extra == "network-viz"
+Requires-Dist: networkx>=3.0.0; extra == "network-viz"
+Requires-Dist: werkzeug>=3.0.0; extra == "network-viz"
+Provides-Extra: full
+Requires-Dist: pyvis==0.3.1; extra == "full"
+Requires-Dist: tsam<3.0.0,>=2.3.1; extra == "full"
+Requires-Dist: scipy<2.0.0,>=1.15.1; extra == "full"
+Requires-Dist: gurobipy>=10.0.0; extra == "full"
+Requires-Dist: dash>=3.0.0; extra == "full"
+Requires-Dist: dash-cytoscape>=1.0.0; extra == "full"
+Requires-Dist: dash-daq>=0.6.0; extra == "full"
+Requires-Dist: networkx>=3.0.0; extra == "full"
+Requires-Dist: werkzeug>=3.0.0; extra == "full"
 Provides-Extra: dev
 Requires-Dist: pytest>=7.0.0; extra == "dev"
 Requires-Dist: ruff>=0.9.0; extra == "dev"
@@ -39,12 +54,11 @@ Requires-Dist: pyvis==0.3.1; extra == "dev"
 Requires-Dist: tsam<3.0.0,>=2.3.1; extra == "dev"
 Requires-Dist: scipy<2.0.0,>=1.15.1; extra == "dev"
 Requires-Dist: gurobipy>=10.0.0; extra == "dev"
-Provides-Extra: full
-Requires-Dist: pyvis==0.3.1; extra == "full"
-Requires-Dist: tsam<3.0.0,>=2.3.1; extra == "full"
-Requires-Dist: scipy<2.0.0,>=1.15.1; extra == "full"
-Requires-Dist: streamlit<2.0.0,>=1.44.0; extra == "full"
-Requires-Dist: gurobipy>=10.0.0; extra == "full"
+Requires-Dist: dash>=3.0.0; extra == "dev"
+Requires-Dist: dash-cytoscape>=1.0.0; extra == "dev"
+Requires-Dist: dash-daq>=0.6.0; extra == "dev"
+Requires-Dist: networkx>=3.0.0; extra == "dev"
+Requires-Dist: werkzeug>=3.0.0; extra == "dev"
 Provides-Extra: docs
 Requires-Dist: mkdocs-material<10,>=9.0.0; extra == "docs"
 Requires-Dist: mkdocstrings-python>=1.0.0; extra == "docs"

{flixopt-2.1.4 → flixopt-2.1.6}/examples/02_Complex/complex_example.py

@@ -182,6 +182,7 @@ if __name__ == '__main__':
     flow_system.add_elements(bhkw_2) if use_chp_with_piecewise_conversion else flow_system.add_elements(bhkw)
 
     pprint(flow_system)  # Get a string representation of the FlowSystem
+    flow_system.start_network_app()  # Start the network app. DOes only work with extra dependencies installed
 
     # --- Solve FlowSystem ---
     calculation = fx.FullCalculation('complex example', flow_system, time_indices)

{flixopt-2.1.4 → flixopt-2.1.6}/flixopt/aggregation.py

@@ -34,7 +34,6 @@ from .structure import (
 if TYPE_CHECKING:
     import plotly.graph_objects as go
 
-warnings.filterwarnings('ignore', category=DeprecationWarning)
 logger = logging.getLogger('flixopt')
 
 

{flixopt-2.1.4 → flixopt-2.1.6}/flixopt/components.py

@@ -3,6 +3,7 @@ This module contains the basic components of the flixopt framework.
 """
 
 import logging
+import warnings
 from typing import TYPE_CHECKING, Dict, List, Literal, Optional, Set, Tuple, Union
 
 import linopy
@@ -586,52 +587,160 @@ class SourceAndSink(Component):
     def __init__(
         self,
         label: str,
-        source: Flow,
-        sink: Flow,
-        prevent_simultaneous_sink_and_source: bool = True,
+        inputs: List[Flow] = None,
+        outputs: List[Flow] = None,
+        prevent_simultaneous_flow_rates: bool = True,
         meta_data: Optional[Dict] = None,
+        **kwargs,
     ):
         """
         Args:
             label: The label of the Element. Used to identify it in the FlowSystem
-            source: output-flow of this component
-            sink: input-flow of this component
-            prevent_simultaneous_sink_and_source: If True, inflow and outflow can not be active simultaniously.
+            outputs: output-flows of this component
+            inputs: input-flows of this component
+            prevent_simultaneous_flow_rates: If True, inflow and outflow can not be active simultaniously.
             meta_data: used to store more information about the Element. Is not used internally, but saved in the results. Only use python native types.
         """
+        source = kwargs.pop('source', None)
+        sink = kwargs.pop('sink', None)
+        prevent_simultaneous_sink_and_source = kwargs.pop('prevent_simultaneous_sink_and_source', None)
+        if source is not None:
+            warnings.deprecated(
+                'The use of the source argument is deprecated. Use the outputs argument instead.',
+                stacklevel=2,
+            )
+            if outputs is not None:
+                raise ValueError('Either source or outputs can be specified, but not both.')
+            outputs = [source]
+
+        if sink is not None:
+            warnings.deprecated(
+                'The use of the sink argument is deprecated. Use the outputs argument instead.',
+                stacklevel=2,
+            )
+            if inputs is not None:
+                raise ValueError('Either sink or outputs can be specified, but not both.')
+            inputs = [sink]
+
+        if prevent_simultaneous_sink_and_source is not None:
+            warnings.deprecated(
+                'The use of the prevent_simultaneous_sink_and_source argument is deprecated. Use the prevent_simultaneous_flow_rates argument instead.',
+                stacklevel=2,
+            )
+            prevent_simultaneous_flow_rates = prevent_simultaneous_sink_and_source
+
         super().__init__(
             label,
-            inputs=[sink],
-            outputs=[source],
-            prevent_simultaneous_flows=[sink, source] if prevent_simultaneous_sink_and_source is True else None,
+            inputs=inputs,
+            outputs=outputs,
+            prevent_simultaneous_flows=inputs + outputs if prevent_simultaneous_flow_rates is True else None,
             meta_data=meta_data,
         )
-        self.source = source
-        self.sink = sink
-        self.prevent_simultaneous_sink_and_source = prevent_simultaneous_sink_and_source
+        self.prevent_simultaneous_flow_rates = prevent_simultaneous_flow_rates
+
+    @property
+    def source(self) -> Flow:
+        warnings.warn(
+            'The source property is deprecated. Use the outputs property instead.',
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        return self.outputs[0]
+
+    @property
+    def sink(self) -> Flow:
+        warnings.warn(
+            'The sink property is deprecated. Use the outputs property instead.',
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        return self.inputs[0]
+
+    @property
+    def prevent_simultaneous_sink_and_source(self) -> bool:
+        warnings.warn(
+            'The prevent_simultaneous_sink_and_source property is deprecated. Use the prevent_simultaneous_flow_rates property instead.',
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        return self.prevent_simultaneous_flow_rates
 
 
 @register_class_for_io
 class Source(Component):
-    def __init__(self, label: str, source: Flow, meta_data: Optional[Dict] = None):
+    def __init__(
+        self,
+        label: str,
+        outputs: List[Flow] = None,
+        meta_data: Optional[Dict] = None,
+        prevent_simultaneous_flow_rates: bool = False,
+        **kwargs
+    ):
         """
         Args:
             label: The label of the Element. Used to identify it in the FlowSystem
-            source: output-flow of source
+            outputs: output-flows of source
             meta_data: used to store more information about the Element. Is not used internally, but saved in the results. Only use python native types.
         """
-        super().__init__(label, outputs=[source], meta_data=meta_data)
-        self.source = source
+        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.',
+                DeprecationWarning,
+                stacklevel=2,
+            )
+            if outputs is not None:
+                raise ValueError('Either source or outputs can be specified, but not both.')
+            outputs = [source]
+
+        self.prevent_simultaneous_flow_rates = prevent_simultaneous_flow_rates
+        super().__init__(label, outputs=outputs, meta_data=meta_data, prevent_simultaneous_flows=outputs if prevent_simultaneous_flow_rates else None)
+
+    @property
+    def source(self) -> Flow:
+        warnings.warn(
+            'The source property is deprecated. Use the outputs property instead.',
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        return self.outputs[0]
 
 
 @register_class_for_io
 class Sink(Component):
-    def __init__(self, label: str, sink: Flow, meta_data: Optional[Dict] = None):
+    def __init__(
+        self,
+        label: str,
+        inputs: List[Flow] = None,
+        meta_data: Optional[Dict] = None,
+        prevent_simultaneous_flow_rates: bool = False,
+        **kwargs
+    ):
         """
         Args:
             label: The label of the Element. Used to identify it in the FlowSystem
-            meta_data: used to store more information about the element. Is not used internally, but saved in the results
-            sink: input-flow of sink
+            inputs: output-flows of source
+            meta_data: used to store more information about the Element. Is not used internally, but saved in the results. Only use python native types.
         """
-        super().__init__(label, inputs=[sink], meta_data=meta_data)
-        self.sink = sink
+        sink = kwargs.pop('sink', None)
+        if sink is not None:
+            warnings.warn(
+                'The use of the sink argument is deprecated. Use the outputs argument instead.',
+                DeprecationWarning,
+                stacklevel=2,
+            )
+            if inputs is not None:
+                raise ValueError('Either sink or outputs can be specified, but not both.')
+            inputs = [sink]
+
+        self.prevent_simultaneous_flow_rates = prevent_simultaneous_flow_rates
+        super().__init__(label, inputs=inputs, meta_data=meta_data, prevent_simultaneous_flows=inputs if prevent_simultaneous_flow_rates else None)
+
+    @property
+    def sink(self) -> Flow:
+        warnings.warn(
+            'The sink property is deprecated. Use the outputs property instead.',
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        return self.inputs[0]

{flixopt-2.1.4 → flixopt-2.1.6}/flixopt/flow_system.py

@@ -61,6 +61,8 @@ class FlowSystem:
 
         self._connected = False
 
+        self._network_app = None
+
     @classmethod
     def from_dataset(cls, ds: xr.Dataset):
         timesteps_extra = pd.DatetimeIndex(ds.attrs['timesteps_extra'], name='time')
@@ -241,6 +243,57 @@ class FlowSystem:
         node_infos, edge_infos = self.network_infos()
         return plotting.plot_network(node_infos, edge_infos, path, controls, show)
 
+    def start_network_app(self):
+        """Visualizes the network structure of a FlowSystem using Dash, Cytoscape, and networkx.
+        Requires optional dependencies: dash, dash-cytoscape, networkx, werkzeug.
+        """
+        from .network_app import DASH_CYTOSCAPE_AVAILABLE, VISUALIZATION_ERROR, flow_graph, shownetwork
+
+        warnings.warn(
+            'The network visualization is still experimental and might change in the future.',
+            stacklevel=2,
+            category=UserWarning,
+        )
+
+        if not DASH_CYTOSCAPE_AVAILABLE:
+            raise ImportError(
+                f"Network visualization requires optional dependencies. "
+                f"Install with: pip install flixopt[viz], flixopt[full] or pip install dash dash_cytoscape networkx werkzeug. "
+                f"Original error: {VISUALIZATION_ERROR}"
+            )
+
+        if not self._connected:
+            self._connect_network()
+
+        if self._network_app is not None:
+            logger.warning('The network app is already running. Restarting it.')
+            self.stop_network_app()
+
+        self._network_app = shownetwork(flow_graph(self))
+
+    def stop_network_app(self):
+        """Stop the network visualization server."""
+        from .network_app import DASH_CYTOSCAPE_AVAILABLE, VISUALIZATION_ERROR
+        if not DASH_CYTOSCAPE_AVAILABLE:
+            raise ImportError(
+                f'Network visualization requires optional dependencies. '
+                f'Install with: pip install flixopt[viz]. '
+                f'Original error: {VISUALIZATION_ERROR}'
+            )
+
+        if self._network_app is None:
+            logger.warning('No network app is currently running. Cant stop it')
+            return
+
+        try:
+            logger.info('Stopping network visualization server...')
+            self._network_app.server_instance.shutdown()
+            logger.info('Network visualization stopped.')
+        except Exception as e:
+            logger.error(f'Failed to stop the network visualization app: {e}')
+        finally:
+            self._network_app = None
+
     def network_infos(self) -> Tuple[Dict[str, Dict[str, str]], Dict[str, Dict[str, str]]]:
         if not self._connected:
             self._connect_network()