pyoframe 0.0.4__py3-none-any.whl → 0.0.6__py3-none-any.whl

{pyoframe-0.0.4.dist-info → pyoframe-0.0.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyoframe
-Version: 0.0.4
+Version: 0.0.6
 Summary: Blazing fast linear program interface
 Author-email: Bravos Power <dev@bravospower.com>
 Project-URL: Homepage, https://bravos-power.github.io/pyoframe/
@@ -15,10 +15,11 @@ Classifier: Natural Language :: English
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: polars ==0.20.13
+Requires-Dist: polars
 Requires-Dist: numpy
 Requires-Dist: pyarrow
 Requires-Dist: pandas
+Requires-Dist: tqdm
 Provides-Extra: dev
 Requires-Dist: black ; extra == 'dev'
 Requires-Dist: bumpver ; extra == 'dev'
@@ -56,3 +57,9 @@ Contributions are welcome! See [`CONTRIBUTE.md`](./CONTRIBUTE.md).
 ## Acknowledgments
 
 Martin Staadecker first created this library while working for [Bravos Power](https://www.bravospower.com/) The library takes inspiration from Linopy and Pyomo, two prior libraries for optimization for which we are thankful.
+
+## Troubleshooting Common Errors
+
+### `datatypes of join keys don't match`
+
+Often, this error indicates that two dataframes in your inputs representing the same dimension have different datatypes (e.g. 16bit integer and 64bit integer). This is not allowed and you should ensure for the same dimensions, datatypes are identical.

pyoframe-0.0.6.dist-info/RECORD

@@ -0,0 +1,18 @@
+pyoframe/__init__.py,sha256=D7HHQPy2Me-LLyfPCcSE74dn83PeMK3aOby7i7oiLTs,507
+pyoframe/_arithmetic.py,sha256=riyN2JC-BnOgTIxGfXKIS-X_p7zm8JaKrLk_KDwKAAw,9046
+pyoframe/constants.py,sha256=olao24mkzQfwTlc5o4rQ-AOOTytmtVqNCFwJIc8zbds,7169
+pyoframe/core.py,sha256=bTaPOfkgIs-9wrXZ3REthNI7y8oj4S9VLe7xKIye7wc,51139
+pyoframe/io.py,sha256=7bd_oKD8EZsuM0ONUAA9BDFSFvUoXLWGXDhnUqMde8o,5235
+pyoframe/io_mappers.py,sha256=Op5451Yo4gNa-2BiPPCAjPYdFLo8jIeKHCYXUcGPRug,7385
+pyoframe/model.py,sha256=xod3hSf__WWDy0V9pao9wPlQTc7-7x56FJoKKidsMbw,3768
+pyoframe/model_element.py,sha256=H2gZxksb3UQ25vIdNlb07bCx3ZcWh7YD6-ViPVJV-JI,7691
+pyoframe/monkey_patch.py,sha256=S_DU7cieU5C3t3kAyKQrGyLTwno0WANpDBV3xn7AyG8,2068
+pyoframe/objective.py,sha256=JzuyMAQZ2OxEoAaK-splWwZei2hHPbCLdG-X2-yRkD0,1338
+pyoframe/solvers.py,sha256=9K4TBSFDf4-O3gP-5CsWlVpZgem4P11tZdvNIspWbjs,11834
+pyoframe/user_defined.py,sha256=UWZSTpFj0a8n1_RHwC8Ubwqr4FO-gRPBqqfNUut1IZg,1717
+pyoframe/util.py,sha256=KJubFV66E7WPI5UhcuUNsVwCm7WOcQBiLN1af1MAAgA,9647
+pyoframe-0.0.6.dist-info/LICENSE,sha256=L1pXz6p_1OW5XGWb2UCR6PNu6k3JAT0XWhi8jV0cuRg,1137
+pyoframe-0.0.6.dist-info/METADATA,sha256=uv31DtVZ0j5QncOmsElAwkhm82DxTvHzOAA4iVsNBi4,3445
+pyoframe-0.0.6.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+pyoframe-0.0.6.dist-info/top_level.txt,sha256=10z3OOJSVLriQ0IrFLMH8CH9zByugPWolqhlHlkNjV4,9
+pyoframe-0.0.6.dist-info/RECORD,,

pyoframe/variables.py

@@ -1,193 +0,0 @@
-"""
-File containing Variable class representing decision variables in optimization models.
-"""
-
-from __future__ import annotations
-from typing import Iterable
-
-import polars as pl
-
-from pyoframe.constraints import SupportsMath, Set
-
-from pyoframe.constants import COEF_KEY, SOLUTION_KEY, VAR_KEY, VType, VTypeValue
-from pyoframe.constraints import Expression
-from pyoframe.model_element import ModelElement
-from pyoframe.constraints import SetTypes
-from pyoframe.util import IdCounterMixin, get_obj_repr
-
-
-class Variable(ModelElement, SupportsMath, IdCounterMixin):
-    """
-    Represents one or many decision variable in an optimization model.
-
-    Parameters:
-        *indexing_sets: SetTypes (typically a DataFrame or Set)
-            If no indexing_sets are provided, a single variable with no dimensions is created.
-            Otherwise, a variable is created for each element in the Cartesian product of the indexing_sets (see Set for details on behaviour).
-        lb: float
-            The lower bound for all variables.
-        ub: float
-            The upper bound for all variables.
-        vtype: VType | VTypeValue
-            The type of the variable. Can be either a VType enum or a string. Default is VType.CONTINUOUS.
-
-    Examples:
-        >>> import pandas as pd
-        >>> from pyoframe import Variable
-        >>> df = pd.DataFrame({"dim1": [1, 1, 2, 2, 3, 3], "dim2": ["a", "b", "a", "b", "a", "b"]})
-        >>> Variable(df)
-        <Variable lb=-inf ub=inf size=6 dimensions={'dim1': 3, 'dim2': 2}>
-        [1,a]: x1
-        [1,b]: x2
-        [2,a]: x3
-        [2,b]: x4
-        [3,a]: x5
-        [3,b]: x6
-        >>> Variable(df[["dim1"]])
-        Traceback (most recent call last):
-        ...
-        ValueError: Duplicate rows found in input data.
-        >>> Variable(df[["dim1"]].drop_duplicates())
-        <Variable lb=-inf ub=inf size=3 dimensions={'dim1': 3}>
-        [1]: x7
-        [2]: x8
-        [3]: x9
-    """
-
-    # TODO: Breaking change, remove support for Iterable[AcceptableSets]
-    def __init__(
-        self,
-        *indexing_sets: SetTypes | Iterable[SetTypes],
-        lb: float = float("-inf"),
-        ub: float = float("inf"),
-        vtype: VType | VTypeValue = VType.CONTINUOUS,
-    ):
-        data = Set(*indexing_sets).data if len(indexing_sets) > 0 else pl.DataFrame()
-        data = self._assign_ids(data)
-
-        super().__init__(data)
-
-        self.vtype: VType = VType(vtype)
-
-        # Tightening the bounds is not strictly necessary, but it adds clarity
-        if self.vtype == VType.BINARY:
-            lb, ub = 0, 1
-
-        self.lb = lb
-        self.ub = ub
-
-    @classmethod
-    def get_id_column_name(cls):
-        return VAR_KEY
-
-    @property
-    def solution(self):
-        if SOLUTION_KEY not in self.data.columns:
-            raise ValueError(f"No solution solution found for Variable '{self.name}'.")
-        df = self.data.select(self.dimensions_unsafe + [SOLUTION_KEY])
-        if df.shape == (1, 1):
-            return df.item()
-        return df
-
-    @solution.setter
-    def solution(self, value):
-        assert sorted(value.columns) == sorted([SOLUTION_KEY, VAR_KEY])
-        df = self.data
-        if SOLUTION_KEY in self.data.columns:
-            df = df.drop(SOLUTION_KEY)
-        self._data = df.join(value, on=VAR_KEY, how="left", validate="1:1")
-
-    @property
-    def ids(self):
-        return self.data.select(self.dimensions_unsafe + [VAR_KEY])
-
-    def __repr__(self):
-        return (
-            get_obj_repr(
-                self, ("name", "lb", "ub"), size=self.data.height, dimensions=self.shape
-            )
-            + "\n"
-            + self.to_expr().to_str(max_line_len=80, max_rows=10)
-        )
-
-    def to_expr(self) -> Expression:
-        return self._new(self.data.drop(SOLUTION_KEY))
-
-    def _new(self, data: pl.DataFrame):
-        e = Expression(data.with_columns(pl.lit(1.0).alias(COEF_KEY)))
-        e._model = self._model
-        # We propogate the unmatched strategy intentionally. Without this a .keep_unmatched() on a variable would always be lost.
-        e.unmatched_strategy = self.unmatched_strategy
-        e.allowed_new_dims = self.allowed_new_dims
-        return e
-
-    def next(self, dim: str, wrap_around: bool = False) -> Expression:
-        """
-        Creates an expression where the variable at each index is the next variable in the specified dimension.
-
-        Parameters:
-            dim:
-                The dimension over which to shift the variable.
-            wrap_around:
-                If True, the last index in the dimension is connected to the first index.
-
-        Examples:
-            >>> import pandas as pd
-            >>> from pyoframe import Variable, Model
-            >>> time_dim = pd.DataFrame({"time": ["00:00", "06:00", "12:00", "18:00"]})
-            >>> space_dim = pd.DataFrame({"city": ["Toronto", "Berlin"]})
-            >>> m = Model()
-            >>> m.bat_charge = Variable(time_dim, space_dim)
-            >>> m.bat_flow = Variable(time_dim, space_dim)
-            >>> # Fails because the dimensions are not the same
-            >>> m.bat_charge + m.bat_flow == m.bat_charge.next("time")
-            Traceback (most recent call last):
-            ...
-            pyoframe._arithmetic.PyoframeError: Failed to add expressions:
-            <Expression size=8 dimensions={'time': 4, 'city': 2} terms=16> + <Expression size=6 dimensions={'city': 2, 'time': 3} terms=6>
-            Due to error:
-            Dataframe has unmatched values. If this is intentional, use .drop_unmatched() or .keep_unmatched()
-            shape: (2, 4)
-            ┌───────┬─────────┬────────────┬────────────┐
-            │ time  ┆ city    ┆ time_right ┆ city_right │
-            │ ---   ┆ ---     ┆ ---        ┆ ---        │
-            │ str   ┆ str     ┆ str        ┆ str        │
-            ╞═══════╪═════════╪════════════╪════════════╡
-            │ 18:00 ┆ Toronto ┆ null       ┆ null       │
-            │ 18:00 ┆ Berlin  ┆ null       ┆ null       │
-            └───────┴─────────┴────────────┴────────────┘
-
-            >>> (m.bat_charge + m.bat_flow).drop_unmatched() == m.bat_charge.next("time")
-            <Constraint sense='=' size=6 dimensions={'time': 3, 'city': 2} terms=18>
-            [00:00,Berlin]: bat_charge[00:00,Berlin] + bat_flow[00:00,Berlin] - bat_charge[06:00,Berlin] = 0
-            [00:00,Toronto]: bat_charge[00:00,Toronto] + bat_flow[00:00,Toronto] - bat_charge[06:00,Toronto] = 0
-            [06:00,Berlin]: bat_charge[06:00,Berlin] + bat_flow[06:00,Berlin] - bat_charge[12:00,Berlin] = 0
-            [06:00,Toronto]: bat_charge[06:00,Toronto] + bat_flow[06:00,Toronto] - bat_charge[12:00,Toronto] = 0
-            [12:00,Berlin]: bat_charge[12:00,Berlin] + bat_flow[12:00,Berlin] - bat_charge[18:00,Berlin] = 0
-            [12:00,Toronto]: bat_charge[12:00,Toronto] + bat_flow[12:00,Toronto] - bat_charge[18:00,Toronto] = 0
-
-            >>> (m.bat_charge + m.bat_flow) == m.bat_charge.next("time", wrap_around=True)
-            <Constraint sense='=' size=8 dimensions={'time': 4, 'city': 2} terms=24>
-            [00:00,Berlin]: bat_charge[00:00,Berlin] + bat_flow[00:00,Berlin] - bat_charge[06:00,Berlin] = 0
-            [00:00,Toronto]: bat_charge[00:00,Toronto] + bat_flow[00:00,Toronto] - bat_charge[06:00,Toronto] = 0
-            [06:00,Berlin]: bat_charge[06:00,Berlin] + bat_flow[06:00,Berlin] - bat_charge[12:00,Berlin] = 0
-            [06:00,Toronto]: bat_charge[06:00,Toronto] + bat_flow[06:00,Toronto] - bat_charge[12:00,Toronto] = 0
-            [12:00,Berlin]: bat_charge[12:00,Berlin] + bat_flow[12:00,Berlin] - bat_charge[18:00,Berlin] = 0
-            [12:00,Toronto]: bat_charge[12:00,Toronto] + bat_flow[12:00,Toronto] - bat_charge[18:00,Toronto] = 0
-            [18:00,Berlin]: bat_charge[18:00,Berlin] + bat_flow[18:00,Berlin] - bat_charge[00:00,Berlin] = 0
-            [18:00,Toronto]: bat_charge[18:00,Toronto] + bat_flow[18:00,Toronto] - bat_charge[00:00,Toronto] = 0
-        """
-
-        wrapped = self.data.select(dim).unique(maintain_order=True).sort(by=dim)
-        wrapped = wrapped.with_columns(pl.col(dim).shift(-1).alias("__next"))
-        if wrap_around:
-            wrapped = wrapped.with_columns(pl.col("__next").fill_null(pl.first(dim)))
-        else:
-            wrapped = wrapped.drop_nulls(dim)
-
-        expr = self.to_expr()
-        data = expr.data.rename({dim: "__prev"})
-        data = data.join(
-            wrapped, left_on="__prev", right_on="__next", how="inner"
-        ).drop(["__prev", "__next"])
-        return expr._new(data)

pyoframe-0.0.4.dist-info/RECORD

@@ -1,18 +0,0 @@
-pyoframe/__init__.py,sha256=GCcDnYaiuPJgFbVznihTvYku7Hs39ayAqo5P0UvSKmM,479
-pyoframe/_arithmetic.py,sha256=9qJRuelwU2ycVjDiUSBf3F-jmS0D4Gq_MKb79tiaU_0,9061
-pyoframe/constants.py,sha256=dPvt90WP2oYTRf32y7hj_W6McnjyJR8fs7NUZtE6dXs,7076
-pyoframe/constraints.py,sha256=jfX4N1XMzOlVYoPRFLP4T0vYxTqM9owsWDlgCK6vVMQ,32229
-pyoframe/io.py,sha256=syecN1aT_d02Hu4D42IAgA13LCrQhWkrSwfONN6y9E8,4067
-pyoframe/io_mappers.py,sha256=Il0lRGv-EvVDa3_M7vCwp0hajQfAbOVZEBDqNIwzNpg,6208
-pyoframe/model.py,sha256=ZkVDWVorAFTXb6Be_04G707jaFqml4eVhkM3Sj1GnNU,3236
-pyoframe/model_element.py,sha256=lj5kd5XmhPDepP4lGhsHG1m1qN_8TS-Dl1cTcfveVHo,3753
-pyoframe/monkey_patch.py,sha256=lSsJir2fXkEl_uScYbfVle99r_WvlWvD298alP2uWlE,2082
-pyoframe/objective.py,sha256=9vDZeDu7fT2A7-DY5WatSJrARQVRHcEWkF7GixpVMa4,1247
-pyoframe/solvers.py,sha256=onudQUoGilQ4oOrMA7vz64a08So82dF28hjxHPQooTM,5532
-pyoframe/util.py,sha256=iMRvnAFEFzpd23ZjgLy30ZiZGsWXpVzsCNtT_BXZYi4,9962
-pyoframe/variables.py,sha256=tPgK3S_Csu-JqY7L5ybs0GdRB7Ha1mG0mAsHdlW0hQI,8878
-pyoframe-0.0.4.dist-info/LICENSE,sha256=L1pXz6p_1OW5XGWb2UCR6PNu6k3JAT0XWhi8jV0cuRg,1137
-pyoframe-0.0.4.dist-info/METADATA,sha256=Fmo2mZ0lji7wMP3lPZ4JsxuH_bCK2bCHUaMGiRMCaeE,3106
-pyoframe-0.0.4.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-pyoframe-0.0.4.dist-info/top_level.txt,sha256=10z3OOJSVLriQ0IrFLMH8CH9zByugPWolqhlHlkNjV4,9
-pyoframe-0.0.4.dist-info/RECORD,,