gamspy 1.18.3__py3-none-any.whl → 1.18.4__py3-none-any.whl

gamspy/__init__.py

@@ -22,20 +22,8 @@ from gamspy._backend.engine import EngineClient
 from gamspy._backend.neos import NeosClient
 from gamspy._config import _set_default_options, get_option, set_options
 from gamspy._container import Container
-from gamspy._model import (
-    FileFormat,
-    Model,
-    ModelStatus,
-    Problem,
-    Sense,
-    SolveStatus,
-)
-from gamspy._options import (
-    ConvertOptions,
-    FreezeOptions,
-    ModelInstanceOptions,
-    Options,
-)
+from gamspy._model import FileFormat, Model, ModelStatus, Problem, Sense, SolveStatus
+from gamspy._options import ConvertOptions, FreezeOptions, Options
 from gamspy._serialization import deserialize, serialize
 from gamspy._symbols import (
     Alias,

gamspy/_algebra/condition.py

@@ -34,6 +34,18 @@ class Condition(operable.Operable):
     ----------
     symbol: ImplicitSymbol | Expression
         Reference to the symbol to be conditioned.
+
+    Examples
+    --------
+    >>> import gamspy as gp
+    >>> m = gp.Container()
+    >>> i = gp.Set(m, "i", records=["i1", "i2", "i3"])
+    >>> a = gp.Parameter(m, "a", domain=i, records=[("i1", 10), ("i2", 20), ("i3", 30)])
+    >>> # Conditional assignment: Set values to 1 where they exceed 15
+    >>> a[i].where[a[i] > 15] = 1
+    >>> a.records.values.tolist()
+    [['i1', 10.0], ['i2', 1.0], ['i3', 1.0]]
+
     """
 
     def __init__(
@@ -124,6 +136,24 @@ class Condition(operable.Operable):
 
     @property
     def records(self) -> pd.DataFrame | None:
+        """
+        The records of the condition.
+
+        Returns
+        -------
+        pd.DataFrame | None
+
+        Examples
+        --------
+        >>> import gamspy as gp
+        >>> m = gp.Container()
+        >>> i = gp.Set(m, "i", records=["i1", "i2", "i3"])
+        >>> a = gp.Parameter(m, "a", domain=i, records=[("i1", 10), ("i2", 20), ("i3", 5)])
+        >>> condition = a[i].where[a[i] > 9]
+        >>> condition.records.values.tolist()
+        [['i1', 10.0], ['i2', 20.0]]
+
+        """
         assert self.container is not None
         assert self.domain is not None
         if isinstance(
@@ -160,6 +190,24 @@ class Condition(operable.Operable):
         return temp_sym.records
 
     def gamsRepr(self) -> str:
+        """
+        Representation of this condition in GAMS.
+
+        Returns
+        -------
+        str
+
+        Examples
+        --------
+        >>> import gamspy as gp
+        >>> m = gp.Container()
+        >>> i = gp.Set(m, "i", records=["i1", "i2"])
+        >>> a = gp.Parameter(m, "a", domain=i)
+        >>> condition = a[i].where[a[i] > 5]
+        >>> condition.gamsRepr()
+        'a(i) $ (a(i) > 5)'
+
+        """
         condition_str = (
             self.condition.gamsRepr()  # type: ignore
             if hasattr(self.condition, "gamsRepr")
@@ -185,6 +233,17 @@ class Condition(operable.Operable):
         Returns
         -------
         str
+
+        Examples
+        --------
+        >>> import gamspy as gp
+        >>> m = gp.Container()
+        >>> i = gp.Set(m, "i", records=["i1", "i2"])
+        >>> a = gp.Parameter(m, "a", domain=i)
+        >>> condition = a[i].where[a[i] > 2]
+        >>> condition.latexRepr()
+        'a_{i} ~ | ~ a_{i} > 2'
+
         """
         condition_str = (
             self.condition.latexRepr()  # type: ignore

gamspy/_algebra/domain.py

@@ -89,5 +89,15 @@ class Domain:
         Returns
         -------
         str
+
+        Examples
+        --------
+        >>> from gamspy import Container, Domain, Set
+        >>> m = Container()
+        >>> X = Set(m, name="x", records=[f"I{i}" for i in range(1, 22)])
+        >>> Y = Set(m, name="y", records=[f"J{j}" for j in range(1, 22)])
+        >>> print(Domain(X, Y).latexRepr())
+        x,y
+
         """
         return utils._get_domain_str(self.sets, latex=True)[1:-1]

gamspy/_algebra/expression.py

@@ -293,16 +293,19 @@ def create_latex_expression(root_node: Expression) -> str:
 
 class Expression(operable.Operable):
     """
-    Expression of two operands and an operation.
+    Represents an expression involving two operands and an operator.
+
+    This class constructs a binary expression tree that can be evaluated or
+    translated into GAMS syntax.
 
     Parameters
     ----------
-    left: str | int | float | Parameter | Variable | None
-        Left operand
-    data: str
-        Operation
-    right: str | int | float | Parameter | Variable | None
-        Right operand
+    left : OperableType | ImplicitEquation | None
+        Left operand.
+    operator : str
+        The operator symbol (e.g., '+', '-', '*', '=', 'eq').
+    right : OperableType | str | None
+        Right operand.
 
     Examples
     --------
@@ -529,11 +532,22 @@ class Expression(operable.Operable):
 
     def latexRepr(self) -> str:
         """
-        Representation of this Expression in Latex.
+        Returns the LaTeX representation of this Expression.
 
         Returns
         -------
         str
+            The LaTeX string.
+
+        Examples
+        --------
+        >>> import gamspy as gp
+        >>> m = gp.Container()
+        >>> a = gp.Parameter(m, name="a")
+        >>> b = gp.Parameter(m, name="b")
+        >>> (a + b).latexRepr()
+        'a + b'
+
         """
         return create_latex_expression(self)
 
@@ -745,6 +759,13 @@ class Expression(operable.Operable):
 
 
 class SetExpression(Expression):
+    """
+    Represents an expression involving set operations.
+
+    This class handles operations specifically for Sets and Aliases, such as
+    union, intersection, difference, and complement.
+    """
+
     def __init__(
         self,
         left: OperableType,

gamspy/_algebra/number.py

@@ -66,5 +66,14 @@ class Number(operable.Operable):
         Returns
         -------
         str
+
+        Examples
+        --------
+        >>> import gamspy as gp
+        >>> m = gp.Container()
+        >>> i = gp.Set(m)
+        >>> print(i.latexRepr())
+        i
+
         """
         return f"{self._value}"

gamspy/_cli/install.py

@@ -1,10 +1,12 @@
 from __future__ import annotations
 
 import importlib
+import json
 import os
 import shutil
 import subprocess
 import sys
+from importlib.metadata import distribution
 from typing import TYPE_CHECKING, Annotated
 
 import certifi
@@ -193,8 +195,20 @@ def license(
         shutil.copy(license, license_path)
 
 
+def is_editable(package_name: str) -> bool:
+    dist = distribution(package_name)
+    text = dist.read_text("direct_url.json")
+    if not text:
+        return False
+    data = json.loads(text)
+    return data.get("dir_info", {}).get("editable", False)
+
+
 def append_dist_info(files, gamspy_base_dir: str):
     """Updates dist-info/RECORD in site-packages for pip uninstall"""
+    if is_editable("gamspy"):
+        return
+
     import gamspy as gp
 
     gamspy_path: str = gp.__path__[0]
@@ -277,29 +291,20 @@ def solver(
             if not skip_pip_install:
                 solver_version = gamspy_base.__version__
                 # install specified solver
-                if use_uv:
-                    command = [
-                        "uv",
-                        "pip",
-                        "install",
-                        f"gamspy-{solver_name}=={solver_version}",
-                        "--force-reinstall",
-                    ]
-                else:
-                    command = [
-                        sys.executable,
-                        "-m",
+                command = ["uv"] if use_uv else [sys.executable, "-m"]
+                command.extend(
+                    [
                         "pip",
                         "install",
                         f"gamspy-{solver_name}=={solver_version}",
                         "--force-reinstall",
                     ]
+                )
                 try:
                     _ = subprocess.run(
                         command,
                         check=True,
                         encoding="utf-8",
-                        stderr=subprocess.PIPE,
                         env=environment_variables,
                     )
                 except subprocess.CalledProcessError as e:

gamspy/_cli/show.py

@@ -36,12 +36,10 @@ SOLVER_PAGE_MAP = {
     "CONVERT": "https://www.gams.com/latest/docs/S_CONVERT.html",
     "COPT": "https://www.gams.com/latest/docs/S_COPT.html",
     "CPLEX": "https://www.gams.com/latest/docs/S_CPLEX.html",
-    "DE": "https://www.gams.com/latest/docs/S_DE.html",
     "DECISC": "https://www.gams.com/latest/docs/S_DECIS.html",
     "DECISM": "https://www.gams.com/latest/docs/S_DECIS.html",
     "DICOPT": "https://www.gams.com/latest/docs/S_DICOPT.html",
     "EXAMINER": "https://www.gams.com/latest/docs/S_EXAMINER.html",
-    "GAMSCHK": "https://www.gams.com/latest/docs/S_GAMSCHK.html",
     "GUROBI": "https://www.gams.com/latest/docs/S_GUROBI.html",
     "HIGHS": "https://www.gams.com/latest/docs/S_HIGHS.html",
     "IPOPT": "https://www.gams.com/latest/docs/S_IPOPT.html",
@@ -51,13 +49,11 @@ SOLVER_PAGE_MAP = {
     "KNITRO": "https://www.gams.com/latest/docs/S_KNITRO.html",
     "LINDO": "https://www.gams.com/latest/docs/S_LINDO.html",
     "LINDOGLOBAL": "https://www.gams.com/latest/docs/S_LINDO.html",
-    "LOGMIP": "https://www.gams.com/latest/docs/S_JAMS.html",
     "MILES": "https://www.gams.com/latest/docs/S_MILES.html",
     "MINOS": "https://www.gams.com/latest/docs/S_MINOS.html",
     "MOSEK": "https://www.gams.com/latest/docs/S_MOSEK.html",
     "MPSGE": "https://www.gams.com/50/docs/UG_MPSGE_Intro.html",
     "NLPEC": "https://www.gams.com/latest/docs/S_NLPEC.html",
-    "ODHCPLEX": "https://www.gams.com/latest/docs/S_ODHCPLEX.html",
     "PATH": "https://www.gams.com/latest/docs/S_PATH.html",
     "QUADMINOS": "https://www.gams.com/latest/docs/S_MINOS.html",
     "RESHOP": "https://www.gams.com/latest/docs/S_RESHOP.html",
@@ -80,28 +76,23 @@ EVALUATIONS: dict[str, Callable[[dict[str, bool], bool], bool]] = {
     "CONVERT": lambda cm, ia: True,
     "COPT": lambda cm, ia: cm["CT"] or cm["CK"],
     "CPLEX": lambda cm, ia: cm["CP"] or cm["CL"],
-    "DE": lambda cm, ia: True,
     "DECISC": lambda cm, ia: cm["DE"] and (cm["CP"] or cm["CL"]),
     "DECISM": lambda cm, ia: cm["DE"] and cm["M5"],
     "DICOPT": lambda cm, ia: cm["DI"],
     "EXAMINER": lambda cm, ia: True,
-    "GAMSCHK": lambda cm, ia: True,
     "GUROBI": lambda cm, ia: cm["GU"] or cm["GL"],
     "HIGHS": lambda cm, ia: cm["HI"] or ia,
     "IPOPT": lambda cm, ia: True,
     "IPOPTH": lambda cm, ia: cm["IP"] or ia,
-    "JAMS": lambda cm, ia: True,
     "KESTREL": lambda cm, ia: True,
     "KNITRO": lambda cm, ia: cm["KN"],
     "LINDO": lambda cm, ia: cm["LD"],
     "LINDOGLOBAL": lambda cm, ia: cm["LD"] or cm["LI"],
-    "LOGMIP": lambda cm, ia: True,
     "MILES": lambda cm, ia: True,
     "MINOS": lambda cm, ia: cm["M5"],
     "MOSEK": lambda cm, ia: cm["MB"] or cm["ML"],
     "MPSGE": lambda cm, ia: cm["GE"],
     "NLPEC": lambda cm, ia: True,
-    "ODHCPLEX": lambda cm, ia: (ia or cm["OD"]) and (cm["CP"] or cm["CL"]),
     "PATH": lambda cm, ia: cm["PT"],
     "QUADMINOS": lambda cm, ia: cm["M5"],
     "RESHOP": lambda cm, ia: True,