pyoframe 0.0.4__tar.gz → 0.0.5__tar.gz

{pyoframe-0.0.4/src/pyoframe.egg-info → pyoframe-0.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyoframe
-Version: 0.0.4
+Version: 0.0.5
 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.4 → pyoframe-0.0.5}/README.md

@@ -17,3 +17,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.4 → pyoframe-0.0.5}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pyoframe"
-version = "0.0.4"
+version = "0.0.5"
 authors = [{ name = "Bravos Power", email = "dev@bravospower.com" }]
 description = "Blazing fast linear program interface"
 readme = "README.md"
@@ -16,7 +16,7 @@ classifiers = [
     "License :: OSI Approved :: MIT License",
     "Natural Language :: English",
 ]
-dependencies = ["polars==0.20.13", "numpy", "pyarrow", "pandas"]
+dependencies = ["polars", "numpy", "pyarrow", "pandas", "tqdm"]
 
 [project.optional-dependencies]
 dev = [
@@ -42,6 +42,12 @@ docs = [
 [tool.isort]
 profile = "black"
 
+[tool.coverage.run]
+include = ["src/pyoframe/*"]
+
+[tool.pytest.ini_options]
+addopts = "--doctest-modules --ignore=scripts"
+
 [project.urls]
 Homepage = "https://bravos-power.github.io/pyoframe/"
 documentation = "https://bravos-power.github.io/pyoframe/"

{pyoframe-0.0.4 → pyoframe-0.0.5}/src/pyoframe/__init__.py

@@ -4,12 +4,21 @@ Also applies the monkey patch to the DataFrame libraries.
 """
 
 from pyoframe.monkey_patch import patch_dataframe_libraries
-from pyoframe.constraints import sum, sum_by, Set, Constraint
+from pyoframe.core import sum, sum_by, Set, Constraint, Expression, Variable
 from pyoframe.constants import Config
-from pyoframe.variables import Variable
 from pyoframe.model import Model
 from pyoframe.constants import VType
 
 patch_dataframe_libraries()
 
-__all__ = ["sum", "sum_by", "Variable", "Model", "Set", "VType", "Config", "Constraint"]
+__all__ = [
+    "sum",
+    "sum_by",
+    "Variable",
+    "Model",
+    "Set",
+    "VType",
+    "Config",
+    "Constraint",
+    "Expression",
+]

{pyoframe-0.0.4 → pyoframe-0.0.5}/src/pyoframe/_arithmetic.py

@@ -7,14 +7,11 @@ from pyoframe.constants import (
     VAR_KEY,
     UnmatchedStrategy,
     Config,
+    PyoframeError,
 )
 
 if TYPE_CHECKING:  # pragma: no cover
-    from pyoframe.constraints import Expression
-
-
-class PyoframeError(Exception):
-    pass
+    from pyoframe.core import Expression
 
 
 def _add_expressions(*expressions: "Expression") -> "Expression":

{pyoframe-0.0.4 → pyoframe-0.0.5}/src/pyoframe/constants.py

@@ -9,7 +9,7 @@ MIT License
 from dataclasses import dataclass
 from enum import Enum
 import typing
-from typing import Any, Literal, Optional, Union
+from typing import Literal, Optional, Union
 import polars as pl
 
 
@@ -18,7 +18,8 @@ VAR_KEY = "__variable_id"
 CONSTRAINT_KEY = "__constraint_id"
 SOLUTION_KEY = "solution"
 DUAL_KEY = "dual"
-NAME_COL = "__name"
+RC_COL = "RC"
+SLACK_COL = "slack"
 
 CONST_TERM = 0
 
@@ -28,7 +29,8 @@ RESERVED_COL_KEYS = (
     CONSTRAINT_KEY,
     SOLUTION_KEY,
     DUAL_KEY,
-    NAME_COL,
+    RC_COL,
+    SLACK_COL,
 )
 
 
@@ -48,6 +50,9 @@ class Config(metaclass=_ConfigMeta):
     disable_unmatched_checks: bool = False
     print_float_precision: Optional[int] = 5
     print_uses_variable_names: bool = True
+    # Number of elements to show when printing a set to the console (additional elements are replaced with ...)
+    print_max_set_elements: int = 50
+    enable_is_duplicated_expression_safety_check: bool = False
 
     @classmethod
     def reset_defaults(cls):
@@ -65,8 +70,8 @@ class ConstraintSense(Enum):
 
 
 class ObjSense(Enum):
-    MIN = "minimize"
-    MAX = "maximize"
+    MIN = "min"
+    MAX = "max"
 
 
 class VType(Enum):
@@ -83,7 +88,7 @@ class UnmatchedStrategy(Enum):
 
 # This is a hack to get the Literal type for VType
 # See: https://stackoverflow.com/questions/67292470/type-hinting-enum-member-value-in-python
-ObjSenseValue = Literal["minimize", "maximize"]
+ObjSenseValue = Literal["min", "max"]
 VTypeValue = Literal["continuous", "binary", "integer"]
 for enum, type in [(ObjSense, ObjSenseValue), (VType, VTypeValue)]:
     assert set(typing.get_args(type)) == {vtype.value for vtype in enum}
@@ -248,13 +253,8 @@ class Result:
 
     status: Status
     solution: Optional[Solution] = None
-    solver_model: Optional[Any] = None
 
     def __repr__(self) -> str:
-        solver_model_string = (
-            "not available" if self.solver_model is None else "available"
-        )
-
         res = (
             f"Status: {self.status.status.value}\n"
             f"Termination condition: {self.status.termination_condition.value}\n"
@@ -264,7 +264,6 @@ class Result:
                 f"Solution: {len(self.solution.primal)} primals, {len(self.solution.dual) if self.solution.dual is not None else 0} duals\n"
                 f"Objective: {self.solution.objective:.2e}\n"
             )
-        res += f"Solver model: {solver_model_string}\n"
 
         return res
 
@@ -278,3 +277,7 @@ class Result:
                 print(f" Optimization successful: \n{self}\n")
         else:
             print(f"Optimization failed: \n{self}\n")
+
+
+class PyoframeError(Exception):
+    pass