flixopt 1.0.12__py3-none-any.whl → 2.0.1__py3-none-any.whl

flixOpt/utils.py

@@ -1,134 +0,0 @@
-"""
-This module contains several utility functions used throughout the flixOpt framework.
-"""
-
-import logging
-from typing import Any, Dict, List, Literal, Optional, Union
-
-import numpy as np
-
-logger = logging.getLogger('flixOpt')
-
-
-def as_vector(value: Union[int, float, np.ndarray, List], length: int) -> np.ndarray:
-    """
-    Macht aus Skalar einen Vektor. Vektor bleibt Vektor.
-    -> Idee dahinter: Aufruf aus abgespeichertem Vektor schneller, als für jede i-te Gleichung zu Checken ob Vektor oder Skalar)
-
-    Parameters
-    ----------
-
-    aValue: skalar, list, np.array
-    aLen  : skalar
-    """
-    # dtype = 'float64' # -> muss mit übergeben werden, sonst entstehen evtl. int32 Reihen (dort ist kein +/-inf möglich)
-    # TODO: as_vector() -> int32 Vektoren möglich machen
-
-    # Wenn Skalar oder None, return directly as array
-    if value is None:
-        return np.array([None] * length)
-    if np.isscalar(value):
-        return np.ones(length) * value
-
-    if len(value) != length:  # Wenn Vektor nicht richtige Länge
-        raise Exception(f'error in changing to {length=}; vector has already {len(value)=}')
-
-    if isinstance(value, np.ndarray):
-        return value
-    else:
-        return np.array(value)
-
-
-def is_number(number_alias: Union[int, float, str]):
-    """Returns True is string is a number."""
-    try:
-        float(number_alias)
-        return True
-    except ValueError:
-        return False
-
-
-def check_time_series(label: str, time_series: np.ndarray[np.datetime64]):
-    # check sowohl für globale Zeitreihe, als auch für chosenIndexe:
-
-    # Zeitdifferenz:
-    #              zweites bis Letztes            - erstes bis Vorletztes
-    dt = time_series[1:] - time_series[0:-1]
-    # dt_in_hours    = dt.total_seconds() / 3600
-    dt_in_hours = dt / np.timedelta64(1, 'h')
-
-    # unterschiedliche dt:
-    if np.max(dt_in_hours) - np.min(dt_in_hours) != 0:
-        logger.warning(f'{label}: !! Achtung !! unterschiedliche delta_t von {min(dt)} h bis  {max(dt)} h')
-    # negative dt:
-    if np.min(dt_in_hours) < 0:
-        raise Exception(label + ': Zeitreihe besitzt Zurücksprünge - vermutlich Zeitumstellung nicht beseitigt!')
-
-
-def apply_formating(
-    data_dict: Dict[str, Union[int, float]],
-    key_format: str = '<17',
-    value_format: str = '>10.2f',
-    indent: int = 0,
-    sort_by: Optional[Literal['key', 'value']] = None,
-) -> str:
-    if sort_by == 'key':
-        sorted_keys = sorted(data_dict.keys(), key=str.lower)
-    elif sort_by == 'value':
-        sorted_keys = sorted(data_dict, key=lambda k: data_dict[k], reverse=True)
-    else:
-        sorted_keys = data_dict.keys()
-
-    lines = [f'{indent * " "}{key:{key_format}}: {data_dict[key]:{value_format}}' for key in sorted_keys]
-    return '\n'.join(lines)
-
-
-def label_is_valid(label: str) -> bool:
-    """Function to make sure '__' is reserved for internal splitting of labels"""
-    if label.startswith('_') or label.endswith('_') or '__' in label:
-        return False
-    return True
-
-
-def convert_numeric_lists_to_arrays(
-    d: Union[Dict[str, Any], List[Any], tuple],
-) -> Union[Dict[str, Any], List[Any], tuple]:
-    """
-    Recursively converts all lists of numeric values in a nested dictionary to numpy arrays.
-    Handles nested lists, tuples, and dictionaries. Does not alter the original dictionary.
-    """
-
-    def convert_list_to_array_if_numeric(sequence: Union[List[Any], tuple]) -> Union[np.ndarray, List[Any]]:
-        """
-        Converts a Sequence to a numpy array if all elements are numeric.
-        Recursively processes each element.
-        Does not alter the original sequence.
-        Returns an empty list if the sequence is empty.
-        """
-        # Check if the list is empty
-        if len(sequence) == 0:
-            return []
-        # Check if all elements are numeric in the list
-        elif isinstance(sequence, list) and all(isinstance(item, (int, float)) for item in sequence):
-            return np.array(sequence)
-        else:
-            return [
-                convert_numeric_lists_to_arrays(item) if isinstance(item, (dict, list, tuple)) else item
-                for item in sequence
-            ]
-
-    if isinstance(d, dict):
-        d_copy = {}  # Reconstruct the dict from ground up to not modify the original dictionary.'
-        for key, value in d.items():
-            if isinstance(value, (list, tuple)):
-                d_copy[key] = convert_list_to_array_if_numeric(value)
-            elif isinstance(value, dict):
-                d_copy[key] = convert_numeric_lists_to_arrays(value)  # Recursively process nested dictionaries
-            else:
-                d_copy[key] = value
-        return d_copy
-    elif isinstance(d, (list, tuple)):
-        # If the input itself is a list or tuple, process it as a sequence
-        return convert_list_to_array_if_numeric(d)
-    else:
-        return d

flixopt-1.0.12.dist-info/METADATA

@@ -1,174 +0,0 @@
-Metadata-Version: 2.2
-Name: flixopt
-Version: 1.0.12
-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>
-License: MIT License
-Project-URL: homepage, https://tu-dresden.de/ing/maschinenwesen/iet/gewv/forschung/forschungsprojekte/flixopt
-Project-URL: repository, https://github.com/flixOpt/flixopt
-Keywords: optimization,energy systems,numerical analysis
-Classifier: Development Status :: 3 - Alpha
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: Science/Research
-Classifier: Topic :: Scientific/Engineering
-Classifier: License :: OSI Approved :: MIT License
-Requires-Python: <3.13,>=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: numpy<2,>=1.21.5
-Requires-Dist: PyYAML>=6.0
-Requires-Dist: Pyomo>=6.4.2
-Requires-Dist: rich>=13.0.1
-Requires-Dist: highspy>=1.5.3
-Requires-Dist: pandas<3,>=2
-Requires-Dist: matplotlib>=3.5.2
-Requires-Dist: plotly>=5.15
-Requires-Dist: tomli>=2.0.1
-Provides-Extra: dev
-Requires-Dist: pytest; extra == "dev"
-Requires-Dist: ruff; extra == "dev"
-Requires-Dist: pyvis==0.3.1; extra == "dev"
-Requires-Dist: tsam>=2.3.1; extra == "dev"
-Provides-Extra: full
-Requires-Dist: pyvis==0.3.1; extra == "full"
-Requires-Dist: tsam>=2.3.1; extra == "full"
-
-# flixOpt: Energy and Material Flow Optimization Framework
-
-**flixOpt** is a Python-based optimization framework designed to tackle energy and material flow problems using mixed-integer linear programming (MILP). Combining flexibility and efficiency, it provides a powerful platform for both dispatch and investment optimization challenges.
-
----
-
-## 🚀 Introduction
-
-flixOpt was developed by [TU Dresden](https://github.com/gewv-tu-dresden) as part of the SMARTBIOGRID project, funded by the German Federal Ministry for Economic Affairs and Energy (FKZ: 03KB159B). Building on the Matlab-based flixOptMat framework (developed in the FAKS project), flixOpt also incorporates concepts from [oemof/solph](https://github.com/oemof/oemof-solph). 
-
-Although flixOpt is in its early stages, it is fully functional and ready for experimentation. It is used for investment and operation decisions by energy providing companys as well as research institutions. Feedback and collaboration are highly encouraged to help shape its future.
-
----
-
-## 📦 Installation
-
-Install flixOpt directly into your environment using pip. Thanks to [HiGHS](https://github.com/ERGO-Code/HiGHS?tab=readme-ov-file), flixOpt can be used without further setup.
-`pip install git+https://github.com/flixOpt/flixopt.git`
-
-We recommend installing flixOpt with all dependencies, which enables interactive network visualizations by [pyvis](https://github.com/WestHealth/pyvis) and time series aggregation by [tsam](https://github.com/FZJ-IEK3-VSA/tsam).
-`pip install "flixOpt[full] @ git+https://github.com/flixOpt/flixopt.git"`
-
----
-
-## 🌟 Key Features and Concepts
-
-### 💡 High-level Interface...
-  - flixOpt aims to provide a user-friendly interface for defining and solving energy systems, without sacrificing fine-grained control where necessary.
-  - This is achieved through a high-level interface with many optional or default parameters.
-  - The most important concepts are:
-    - **FlowSystem**: Represents the System that is modeled.
-    - **Flow**: A Flow represents a stream of matter or energy. In an Energy-System, it could be electricity [kW]
-    - **Bus**: A Bus represents a balancing node in the Energy-System, typically connecting a demand to a supply.
-    - **Component**: A Component is a physical entity that consumes or produces matter or energy. It can also transform matter or energy into other kinds of matter or energy.
-    - **Effect**: Flows and Components can have Effects, related to their usage (or size). Common effects are *costs*, *CO2-emissions*, *primary-energy-demand* or *area-demand*. One Effect is used as the optimization target. The others can be constrained.
-  - To simplify the modeling process, high-level **Components** (CHP, Boiler, Heat Pump, Cooling Tower, Storage, etc.) are availlable.
-
-### 🎛️ ...with low-level control
-- **Segmented Linear Correlations**  
-  - Accurate modeling for efficiencies, investment effects, and sizes.
-- **On/Off Variables**
-  - Modeling On/Off-Variables and their constraints.
-    - On-Hours/Off-Hours
-    - Consecutive On-Hours/ Off-Hours
-    - Switch On/Off
-
-### 💰 Investment Optimization
-- flixOpt combines dispatch optimization with investment optimization in one model.
-- Size and/or discrete investment decisions can be modeled
-- Investment decisions can be combined with Modeling On/Off-Variables and their constraints
-
-### Further Features
-- **Multiple Effects**
-  - Couple effects (e.g., specific CO2 costs) and set constraints (e.g., max CO2 emissions).
-  - Easily switch between optimization targets (e.g., minimize CO2 or costs).
-  - This allows to solve questions like "How much does it cost to reduce CO2 emissions by 20%?"
-
-- **Advanced Time Handling**
-  - Non-equidistant timesteps supported.  
-  - Energy prices or effects in general can always be defined per hour (or per MWh...)
-
-  - A variety of predefined constraints for operational and investment optimization can be applied.
-  - Many of these are optional and only applied when necessary, keeping the amount o variables and equations low.
-
----
-
-## 🖥️ Usage Example
-![Usage Example](https://github.com/user-attachments/assets/fa0e12fa-2853-4f51-a9e2-804abbefe20c)
-
-**Plotting examples**:
-![flixOpt plotting](/pics/flixOpt_plotting.jpg)
-
-## ⚙️ Calculation Modes
-
-flixOpt offers three calculation modes, tailored to different performance and accuracy needs:
-
-- **Full Mode**  
-  - Provides exact solutions with high computational requirements.  
-  - Recommended for detailed analyses and investment decision problems.
-
-- **Segmented Mode**  
-  - Solving a Model segmentwise, this mode can speed up the solving process for complex systems, while being fairly accurate.
-  - Utilizes variable time overlap to improve accuracy.
-  - Not suitable for large storage systems or investment decisions.
-
-- **Aggregated Mode**  
-  - Automatically generates typical periods using [TSAM](https://github.com/FZJ-IEK3-VSA/tsam).  
-  - Balances speed and accuracy, making it ideal for large-scale simulations.
-
-
-## 🏗️ Architecture
-
-- **Minimal coupling to Pyomo**
-  - Included independent module is used to organize variables and equations, independently of a specific modeling language.
-  - While currently only working with [Pyomo](http://www.pyomo.org/), flixOpt is designed to work with different modeling languages with minor modifications ([cvxpy](https://www.cvxpy.org)).
-
-- **File-based Post-Processing Unit**
-  - Results are saved to .json and .yaml files for easy access and analysis anytime.
-  - Internal plotting functions utilizing matplotlib, plotly and pandas simplify results visualization and reporting.
-
-![Architecture Diagram](/pics/architecture_flixOpt.png)
-
----
-
-## 🛠️ Solver Integration
-
-By default, flixOpt uses the open-source solver [HiGHS](https://highs.dev/) which is installed by default. However, it is compatible with additional solvers such as:  
-
-- [CBC](https://github.com/coin-or/Cbc)  
-- [GLPK](https://www.gnu.org/software/glpk/)  
-- [Gurobi](https://www.gurobi.com/)  
-- [CPLEX](https://www.ibm.com/analytics/cplex-optimizer)
-
-Executables can be found for example [here for CBC](https://portal.ampl.com/dl/open/cbc/) and [here for GLPK](https://sourceforge.net/projects/winglpk/) (Windows: You have to put solver-executables to the PATH-variable)
-
-For detailed licensing and installation instructions, refer to the respective solver documentation.  
-
----
-
-## 📖 Citation
-
-If you use flixOpt in your research or project, please cite the following:  
-
-- **Main Citation:** [DOI:10.18086/eurosun.2022.04.07](https://doi.org/10.18086/eurosun.2022.04.07)  
-- **Short Overview:** [DOI:10.13140/RG.2.2.14948.24969](https://doi.org/10.13140/RG.2.2.14948.24969)  
-
----
-
-## 🔧 Development and Testing
-
-Run the tests using:  
-
-```bash
-python -m unittest discover -s tests

flixopt-1.0.12.dist-info/RECORD

@@ -1,29 +0,0 @@
-flixOpt/__init__.py,sha256=6TKjBgxKAH9jPmyq7kgbl5v7JPswpOG7vkmU_nu0QSM,568
-flixOpt/aggregation.py,sha256=e3X1Mf1tYYcMve8TV7X8TGvpHaWWw6K180ShwJgY1uY,18274
-flixOpt/calculation.py,sha256=UgxhMEwN5uNQ_BlW8RinBq8d8PvK2kMG_KV9oZkQ8Rw,27565
-flixOpt/commons.py,sha256=8eAyWgJJsxiZhlw08p8c6DROo6gUVvYNvWC1gL1HaCg,1170
-flixOpt/components.py,sha256=AZ6CqXdsP-V1cTA827Sfw01VLARnjNurHxcOCb5ihh0,27914
-flixOpt/config.py,sha256=QyONJ7pBEGwYZYhHiuvsXSIPqBaB7Hptj-q0c5ch6VI,9074
-flixOpt/config.yaml,sha256=othy1lY-YFb1DcDc__Ub3QRYMW7W_DI8JQDUYoiCzuU,392
-flixOpt/core.py,sha256=46jKUxeJMSeWczv52IOwIyPFaH0m9eMpvYyeWPoACac,7223
-flixOpt/effects.py,sha256=InL5OtwuwHVcJaerplqeaDCMmMCw9T08HjuvAc23aTg,17188
-flixOpt/elements.py,sha256=HXe_Y89q5rarFR7t8iY75FwW0cTEBNCEFmqvv9wyxOY,21275
-flixOpt/features.py,sha256=MzWYY9qDcVVIY4hjxzgEjVZIUB04RFZZlUsbnjOzs5E,44650
-flixOpt/flow_system.py,sha256=L0_Ycqn_ypY9ZdWp36YxEcxIuFpj6swuZ_oHkdya314,14668
-flixOpt/interface.py,sha256=mIYff3n5egBDZlslFIrcaH1hVjFSK1Ue1po8o0J_uEk,9236
-flixOpt/linear_converters.py,sha256=SYW01vxglL3XJT5YWtqCL7DljSULv9nYEmXZEY3n2w8,9040
-flixOpt/math_modeling.py,sha256=IIiV-ey2zMxCR_kMYKiUSGHBv8UPYZcmdFXqp6bCUmQ,44580
-flixOpt/plotting.py,sha256=scd5A9kdI6H_neYXy2mowX1xd5a_mh2xZYhvBPDnSpY,27328
-flixOpt/results.py,sha256=8zCCthlHMiXdOkVXqrJeu_Fk3FASgm3yo-mkvZFFMyY,23651
-flixOpt/solvers.py,sha256=sxPO7UWN-uQhRBysL8k94Fh9lCUkKS5CrHjeeidaLaU,372
-flixOpt/structure.py,sha256=eyyRtfvaSJUYAg1rmXB07S7Yq9q7GQgssgbEblYF68w,31281
-flixOpt/utils.py,sha256=MiAjFomptEKTMJTrCbQCfz_KawGGwGzMcZ1I2uJ6SH8,4879
-pics/architecture_flixOpt.png,sha256=9RWSA3vys588aadr2437zor-_-xBTQNQ0bAf8xGcu5g,70605
-pics/flixOpt_plotting.jpg,sha256=zn7ZPAtXm5eRTxtOj86e4-PPhHpCar1jqGh7vMBgQGY,518862
-pics/pics.pptx,sha256=qoKyHscmFVcsQouk1u5cSOHE0cQB81iSW7hOz3-chZo,46213
-tests/ressources/Zeitreihen2020.csv,sha256=kbsDTKZS0iUsNZAS7m3DohzZI_OHHWe44s3GwLvcTLw,1918412
-flixopt-1.0.12.dist-info/LICENSE,sha256=HKsZnbrM_3Rvnr_u9cWSG90cBsj5_slaqI_z_qcxnGI,1118
-flixopt-1.0.12.dist-info/METADATA,sha256=LEXaB8LXOgPaX98dt5V04aTq-vJ9hdG2-Izxy2ke0Ic,8626
-flixopt-1.0.12.dist-info/WHEEL,sha256=beeZ86-EfXScwlR_HKu4SllMC9wUEj_8Z_4FJ3egI2w,91
-flixopt-1.0.12.dist-info/top_level.txt,sha256=vJmCV_Cs0sqibC1u7Z4WWpwlh_q7KPwOLWJSZ7C1DrU,19
-flixopt-1.0.12.dist-info/RECORD,,

flixopt-1.0.12.dist-info/top_level.txt

@@ -1,3 +0,0 @@
-flixOpt
-pics
-tests