gamspy 1.18.4__tar.gz → 1.19.1__tar.gz

{gamspy-1.18.4 → gamspy-1.19.1}/LICENSE

@@ -1,7 +1,7 @@
-GAMSpy - General Algebraic Modeling in Python
+GAMSPy - General Algebraic Modeling in Python
 
-Copyright (c) 2024 GAMS Development Corp. <support@gams.com>
-Copyright (c) 2024 GAMS Software GmbH <support@gams.com>
+Copyright (c) 2026 GAMS Development Corp. <support@gams.com>
+Copyright (c) 2026 GAMS Software GmbH <support@gams.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

{gamspy-1.18.4/src/gamspy.egg-info → gamspy-1.19.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gamspy
-Version: 1.18.4
+Version: 1.19.1
 Summary: Python-based algebraic modeling interface to GAMS
 Author-email: GAMS Development Corporation <support@gams.com>
 Project-URL: homepage, https://gams.com/sales/gamspy_facts/
@@ -37,37 +37,6 @@ Requires-Dist: pandas<2.4,>=2.2.2
 Requires-Dist: pydantic>=2.0
 Requires-Dist: requests>=2.28.0
 Requires-Dist: typer>=0.16.0
-Provides-Extra: dev
-Requires-Dist: ruff>=0.13.0; extra == "dev"
-Requires-Dist: pre-commit>=3.5.0; extra == "dev"
-Requires-Dist: mypy>=1.18.1; extra == "dev"
-Requires-Dist: griffe>=1.14.0; extra == "dev"
-Provides-Extra: test
-Requires-Dist: coverage[toml]>=7.2.7; extra == "test"
-Requires-Dist: openpyxl>=3.1.2; extra == "test"
-Requires-Dist: cerberus>=1.3.5; extra == "test"
-Requires-Dist: python-dotenv>=1.0.0; extra == "test"
-Requires-Dist: pytest>=8.0.0; extra == "test"
-Requires-Dist: networkx>=3.2.1; extra == "test"
-Requires-Dist: scikit-learn>=1.6.1; extra == "test"
-Provides-Extra: doc
-Requires-Dist: sphinx>=7.1.2; extra == "doc"
-Requires-Dist: numpydoc>=1.5.0; extra == "doc"
-Requires-Dist: nbsphinx>=0.9.3; extra == "doc"
-Requires-Dist: sphinx_copybutton>=0.5.2; extra == "doc"
-Requires-Dist: sphinx-favicon>=1.0.1; extra == "doc"
-Requires-Dist: ipykernel; extra == "doc"
-Requires-Dist: matplotlib>=3.7.3; extra == "doc"
-Requires-Dist: sphinx_design>=0.5.0; extra == "doc"
-Requires-Dist: pydata_sphinx_theme>=0.14.1; extra == "doc"
-Requires-Dist: plotly>=5.22.0; extra == "doc"
-Requires-Dist: kaleido==0.2.1; extra == "doc"
-Requires-Dist: pytest>=8.2.1; extra == "doc"
-Requires-Dist: nbmake>=1.5.3; extra == "doc"
-Requires-Dist: openpyxl>=3.1.2; extra == "doc"
-Requires-Dist: sphinx-tabs>=3.4.7; extra == "doc"
-Requires-Dist: towncrier>=24.8.0; extra == "doc"
-Requires-Dist: geopandas>=1.1.1; extra == "doc"
 Provides-Extra: torch
 Requires-Dist: torch>=2.7.0; extra == "torch"
 Dynamic: license-file

{gamspy-1.18.4 → gamspy-1.19.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "gamspy"
-version = "1.18.4"
+version = "1.19.1"
 authors = [
   { name = "GAMS Development Corporation", email = "support@gams.com" },
 ]
@@ -52,43 +52,6 @@ changelog = "https://github.com/GAMS-dev/gamspy/blob/develop/CHANGELOG.md"
 
 
 [project.optional-dependencies]
-dev = [
-  "ruff >= 0.13.0",
-  "pre-commit >= 3.5.0",
-  "mypy >= 1.18.1",
-  "griffe >= 1.14.0",
-]
-
-test = [
-  "coverage[toml] >= 7.2.7",
-  "openpyxl >= 3.1.2",
-  "cerberus >= 1.3.5",
-  "python-dotenv >= 1.0.0",
-  "pytest >= 8.0.0",
-  "networkx >= 3.2.1",
-  "scikit-learn >= 1.6.1",
-]
-
-doc = [
-  "sphinx>=7.1.2",
-  "numpydoc>=1.5.0",
-  "nbsphinx>=0.9.3",
-  "sphinx_copybutton>=0.5.2",
-  "sphinx-favicon>=1.0.1",
-  "ipykernel",
-  "matplotlib>=3.7.3",
-  "sphinx_design>=0.5.0",
-  "pydata_sphinx_theme>=0.14.1",
-  "plotly>=5.22.0",
-  "kaleido==0.2.1",
-  "pytest>=8.2.1",
-  "nbmake>=1.5.3",
-  "openpyxl>=3.1.2",
-  "sphinx-tabs>=3.4.7",
-  "towncrier>= 24.8.0",
-  "geopandas >= 1.1.1",
-]
-
 torch = [
     "torch>=2.7.0"
 ]
@@ -103,6 +66,44 @@ name = "pytorch-cpu"
 url = "https://download.pytorch.org/whl/cpu"
 explicit = true
 
+[dependency-groups]
+dev = [
+    "griffe>=1.15.0",
+    "mypy>=1.19.1",
+    "prek>=0.2.28",
+    "ruff>=0.14.11",
+]
+doc = [
+    "geopandas>=1.1.2",
+    "ipykernel>=7.1.0",
+    "kaleido>=0.2.1",
+    "matplotlib>=3.10.8",
+    "nbmake>=1.5.5",
+    "nbsphinx>=0.9.8",
+    "numpydoc>=1.10.0",
+    "openpyxl>=3.1.5",
+    "plotly>=6.5.1",
+    "pydata-sphinx-theme>=0.16.1",
+    "pytest>=9.0.2",
+    "sphinx>=8.1.3",
+    "sphinx-copybutton>=0.5.2",
+    "sphinx-design>=0.6.1",
+    "sphinx-favicon>=1.0.1",
+    "sphinx-tabs>=3.4.7",
+    "towncrier>=25.8.0",
+]
+test = [
+    "cerberus>=1.3.8",
+    "coverage[toml]>=7.13.1",
+    "networkx>=3.4.2",
+    "openpyxl>=3.1.5",
+    "pip>=25.3",
+    "pytest>=9.0.2",
+    "python-dotenv>=1.2.1",
+    "pyyaml>=6.0.3",
+    "scikit-learn>=1.7.2",
+]
+
 [project.scripts]
 gamspy = "gamspy._cli.cli:main"
 

{gamspy-1.18.4 → gamspy-1.19.1}/src/gamspy/_algebra/condition.py

@@ -129,6 +129,25 @@ class Condition(operable.Operable):
 
     @property
     def dimension(self) -> int:
+        """
+        The dimension of the records of the condition.
+
+        Returns
+        -------
+        int
+            Dimensionality
+
+        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.dimension
+        1
+
+        """
         if self.domain is None:
             return 0
 
@@ -224,6 +243,24 @@ class Condition(operable.Operable):
         return f"{conditioning_on_str} $ ({condition_str})"  # type: ignore
 
     def getDeclaration(self) -> str:
+        """
+        Declaration 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.getDeclaration()
+        'a(i) $ (a(i) > 5)'
+
+        """
         return self.gamsRepr()
 
     def latexRepr(self) -> str:

{gamspy-1.18.4 → gamspy-1.19.1}/src/gamspy/_algebra/operation.py

@@ -2,6 +2,8 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING
 
+from typing_extensions import override
+
 import gamspy._algebra.condition as condition
 import gamspy._algebra.domain as domain
 import gamspy._algebra.expression as expression
@@ -30,19 +32,45 @@ if TYPE_CHECKING:
 
 
 class Operation(operable.Operable):
-    def __init__(
-        self,
-        domain: Set | Alias | ImplicitSet | Sequence[Set | Alias] | Domain | Condition,
-        rhs: (
-            Expression
-            | Operation
+    """
+    Base class for different operations (Sum, Product etc.) over a domain.
+
+    Parameters
+    ----------
+    domain : Set | Alias | ImplicitSet | Sequence[Set | Alias], Domain, Condition
+    rhs : Operation
+            | Expression
             | MathOp
-            | ImplicitSet
             | ImplicitVariable
             | ImplicitParameter
             | int
             | bool
-        ),
+            | Variable
+            | Parameter
+
+    Examples
+    --------
+    >>> import gamspy as gp
+    >>> m = gp.Container()
+    >>> i = gp.Set(m, "i", records=['i1','i2', 'i3'])
+    >>> v = gp.Variable(m, "v")
+    >>> e = gp.Equation(m, "e", type="eq")
+    >>> d = gp.Parameter(m, "d", domain=[i], records=[("i1", 1), ("i2", 2), ("i3", 4)])
+    >>> e[...] = gp.Sum(i, d[i]) <= v
+
+    """
+
+    def __init__(
+        self,
+        domain: Set | Alias | ImplicitSet | Sequence[Set | Alias] | Domain | Condition,
+        rhs: Operation
+        | Expression
+        | MathOp
+        | ImplicitVariable
+        | ImplicitParameter
+        | ImplicitSet
+        | int
+        | bool,
         op_name: str,
     ):
         self.op_domain = utils._to_list(domain)  # type: ignore
@@ -93,6 +121,18 @@ class Operation(operable.Operable):
         Returns
         -------
         pd.DataFrame | None
+
+        Examples
+        --------
+        >>> import numpy as np
+        >>> import gamspy as gp
+        >>> m = gp.Container()
+        >>> i = gp.Set(m, "i", records=["i1", "i2"])
+        >>> a = gp.Parameter(m, "a", domain=i, records=np.array([1,2]))
+        >>> gp.Sum(i, a[i]).records
+           value
+        0    3.0
+
         """
         assert self.container is not None
         temp_name = "a" + utils._get_unique_name()
@@ -117,6 +157,17 @@ class Operation(operable.Operable):
         Returns
         -------
         float | None
+
+        Examples
+        --------
+        >>> import numpy as np
+        >>> import gamspy as gp
+        >>> m = gp.Container()
+        >>> i = gp.Set(m, "i", records=["i1", "i2"])
+        >>> a = gp.Parameter(m, "a", domain=i, records=np.array([1,2]))
+        >>> gp.Sum(i, a[i]).toValue()
+        np.float64(3.0)
+
         """
         records = self.records
         if records is not None:
@@ -131,6 +182,18 @@ class Operation(operable.Operable):
         Returns
         -------
         list | None
+
+        Examples
+        --------
+        >>> import numpy as np
+        >>> import gamspy as gp
+        >>> m = gp.Container()
+        >>> i = gp.Set(m, "i", records=["i1", "i2"])
+        >>> j = gp.Set(m, "j", records=["j1", "j2"])
+        >>> a = gp.Parameter(m, "a", domain=[i, j], records=np.array([(1,2), (3,4)]))
+        >>> gp.Sum(i, a[i, j]).toList()
+        [['j1', 4.0], ['j2', 6.0]]
+
         """
         records = self.records
         if records is not None:
@@ -195,6 +258,24 @@ class Operation(operable.Operable):
         return output
 
     def gamsRepr(self) -> str:
+        """
+        Representation of this operation in GAMS.
+
+        Returns
+        -------
+        str
+
+        Examples
+        --------
+        >>> import numpy as np
+        >>> import gamspy as gp
+        >>> m = gp.Container()
+        >>> i = gp.Set(m, "i", records=range(3))
+        >>> a = gp.Parameter(m, "a", domain=i, records=np.array([3,5,7]))
+        >>> print(gp.Sum(i, a[i]).gamsRepr())
+        sum(i,a(i))
+
+        """
         # Ex: sum((i,j), c(i,j) * x(i,j))
         output = f"{self._op_name}("
 
@@ -231,6 +312,16 @@ class Operation(operable.Operable):
         Returns
         -------
         str
+
+        Examples
+        --------
+        >>> import numpy as np
+        >>> import gamspy as gp
+        >>> m = gp.Container()
+        >>> i = gp.Set(m, "i", records=range(3))
+        >>> a = gp.Parameter(m, "a", domain=i, records=np.array([3,5,7]))
+        >>> print(gp.Sum(i, a[i]).latexRepr()) # doctest: +SKIP
+
         """
         op_map = {
             "sum": "sum",
@@ -274,8 +365,8 @@ class Sum(Operation):
     Parameters
     ----------
     domain : Set | Alias | ImplicitSet | Sequence[Set | Alias], Domain, Condition
-    expression : (
-            Expression
+    expression : Operation
+            | Expression
             | MathOp
             | ImplicitVariable
             | ImplicitParameter
@@ -283,8 +374,6 @@ class Sum(Operation):
             | bool
             | Variable
             | Parameter
-            | Operation
-        )
 
     Examples
     --------
@@ -315,6 +404,7 @@ class Sum(Operation):
     def __repr__(self) -> str:
         return f"Sum(domain={self.domain}, expression={self.rhs})"
 
+    @override
     def gamsRepr(self):
         """
         Representation of the Sum operation in GAMS language.
@@ -344,9 +434,9 @@ class Product(Operation):
 
     Parameters
     ----------
-    domain : Set | Alias | Sequence[Set | Alias], Domain, Expression
-    expression : (
-            Expression
+    domain : Set | Alias | ImplicitSet | Sequence[Set | Alias], Domain, Condition
+    expression : Operation
+            | Expression
             | MathOp
             | ImplicitVariable
             | ImplicitParameter
@@ -354,8 +444,6 @@ class Product(Operation):
             | bool
             | Variable
             | Parameter
-            | Operation
-        )
 
     Examples
     --------
@@ -386,6 +474,7 @@ class Product(Operation):
     def __repr__(self) -> str:
         return f"Product(domain={self.domain}, expression={self.rhs})"
 
+    @override
     def gamsRepr(self):
         """
         Representation of the Product operation in GAMS language.
@@ -415,9 +504,9 @@ class Smin(Operation):
 
     Parameters
     ----------
-    domain : Set | Alias | Sequence[Set | Alias], Domain, Expression
-    expression : (
-            Expression
+    domain : Set | Alias | ImplicitSet | Sequence[Set | Alias], Domain, Condition
+    expression : Operation
+            | Expression
             | MathOp
             | ImplicitVariable
             | ImplicitParameter
@@ -425,8 +514,6 @@ class Smin(Operation):
             | bool
             | Variable
             | Parameter
-            | Operation
-        )
 
     Examples
     --------
@@ -457,6 +544,7 @@ class Smin(Operation):
     def __repr__(self) -> str:
         return f"Smin(domain={self.domain}, expression={self.rhs})"
 
+    @override
     def gamsRepr(self):
         """
         Representation of the Smin operation in GAMS language.
@@ -486,9 +574,9 @@ class Smax(Operation):
 
     Parameters
     ----------
-    domain : Set | Alias | Sequence[Set | Alias], Domain, Expression
-    expression : (
-            Expression
+    domain : Set | Alias | ImplicitSet | Sequence[Set | Alias], Domain, Condition
+    expression : Operation
+            | Expression
             | MathOp
             | ImplicitVariable
             | ImplicitParameter
@@ -496,8 +584,6 @@ class Smax(Operation):
             | bool
             | Variable
             | Parameter
-            | Operation
-        )
 
     Examples
     --------
@@ -528,6 +614,7 @@ class Smax(Operation):
     def __repr__(self) -> str:
         return f"Smax(domain={self.domain}, expression={self.rhs})"
 
+    @override
     def gamsRepr(self):
         """
         Representation of the Smax operation in GAMS language.
@@ -557,9 +644,9 @@ class Sand(Operation):
 
     Parameters
     ----------
-    domain : Set | Alias | Sequence[Set | Alias], Domain, Expression
-    expression : (
-            Expression
+    domain : Set | Alias | ImplicitSet | Sequence[Set | Alias], Domain, Condition
+    expression : Operation
+            | Expression
             | MathOp
             | ImplicitVariable
             | ImplicitParameter
@@ -567,8 +654,6 @@ class Sand(Operation):
             | bool
             | Variable
             | Parameter
-            | Operation
-        )
 
     Examples
     --------
@@ -599,6 +684,7 @@ class Sand(Operation):
     def __repr__(self) -> str:
         return f"Sand(domain={self.domain}, expression={self.rhs})"
 
+    @override
     def gamsRepr(self):
         """
         Representation of the Sand operation in GAMS language.
@@ -627,9 +713,9 @@ class Sor(Operation):
 
     Parameters
     ----------
-    domain : Set | Alias | Sequence[Set | Alias], Domain, Expression
-    expression : (
-            Expression
+    domain : Set | Alias | ImplicitSet | Sequence[Set | Alias], Domain, Condition
+    expression : Operation
+            | Expression
             | MathOp
             | ImplicitVariable
             | ImplicitParameter
@@ -637,8 +723,6 @@ class Sor(Operation):
             | bool
             | Variable
             | Parameter
-            | Operation
-        )
 
     Examples
     --------
@@ -669,6 +753,7 @@ class Sor(Operation):
     def __repr__(self) -> str:
         return f"Sor(domain={self.domain}, expression={self.rhs})"
 
+    @override
     def gamsRepr(self):
         """
         Representation of the Sor operation in GAMS language.
@@ -762,6 +847,15 @@ class Ord(operable.Operable):
         Returns
         -------
         str
+
+        Examples
+        --------
+        >>> import gamspy as gp
+        >>> m = gp.Container()
+        >>> i = gp.Set(m, "i")
+        >>> print(gp.Ord(i).latexRepr())
+        ord(i)
+
         """
         return f"ord({self._symbol._latex_name})"
 
@@ -841,5 +935,14 @@ class Card(operable.Operable):
         Returns
         -------
         str
+
+        Examples
+        --------
+        >>> import gamspy as gp
+        >>> m = gp.Container()
+        >>> i = gp.Set(m, "i")
+        >>> print(gp.Card(i).latexRepr())
+        card(i)
+
         """
         return f"card({self._symbol._latex_name})"

{gamspy-1.18.4 → gamspy-1.19.1}/src/gamspy/_backend/backend.py

@@ -222,7 +222,9 @@ class Backend(ABC):
             symbols = filtered_names
 
         if len(symbols) != 0:
-            self.container._load_records_from_gdx(self.container._gdx_out, symbols)
+            self.container._load_records_from_gdx(
+                self.container._gdx_out, symbols, create_if_not_declared=True
+            )
             self.make_unmodified(symbols)
 
         if relaxed_domain_mapping:

{gamspy-1.18.4 → gamspy-1.19.1}/src/gamspy/_backend/engine.py

@@ -798,14 +798,14 @@ class GAMSEngine(backend.Backend):
         return summary
 
     def execute_gams(self, gams_string: str):
-        extra_options = {
+        hidden_options = {
             "gdx": os.path.basename(self.container._gdx_out),
             "gdxSymbols": "newOrChanged",
             "trace": os.path.basename(self.trace_file),
             "restart": os.path.basename(self.restart_file),
             "input": os.path.basename(self.gms_file),
         }
-        self.options._set_extra_options(extra_options)
+        self.options._set_hidden_options(hidden_options)
         self.options._export(self.pf_file, self.output)
 
         with open(self.gms_file, "w", encoding="utf-8") as file:
@@ -891,7 +891,7 @@ class GAMSEngine(backend.Backend):
     def _prepare_dummy_options(self) -> dict:
         scrdir = self.container._process_directory
 
-        extra_options = {
+        hidden_options = {
             "gdx": self.container._gdx_out,
             "gdxSymbols": "newOrChanged",
             "trace": self.trace_file,
@@ -905,18 +905,18 @@ class GAMSEngine(backend.Backend):
         }
 
         if self.container._network_license:
-            extra_options["netlicense"] = os.path.join(scrdir, "gamslice.dat")
+            hidden_options["netlicense"] = os.path.join(scrdir, "gamslice.dat")
 
-        return extra_options
+        return hidden_options
 
     def _create_restart_file(self):
         with open(self.gms_file, "w", encoding="utf-8") as gams_file:
             gams_file.write("")
 
         options = Options()
-        extra_options = self._prepare_dummy_options()
-        options._set_extra_options(extra_options)
-        options._extra_options["save"] = self.restart_file
+        hidden_options = self._prepare_dummy_options()
+        options._set_hidden_options(hidden_options)
+        options._hidden_options["save"] = self.restart_file
         options._export(self.pf_file)
 
         send_job(self.container._comm_pair_id, self.job_name, self.pf_file)
@@ -930,8 +930,8 @@ class GAMSEngine(backend.Backend):
             gams_file.write(f'execute_load "{self.container._gdx_out}", {dirty_str};')
 
         options = Options()
-        extra_options = self._prepare_dummy_options()
-        options._set_extra_options(extra_options)
+        hidden_options = self._prepare_dummy_options()
+        options._set_hidden_options(hidden_options)
         options._export(self.pf_file)
 
         send_job(self.container._comm_pair_id, self.job_name, self.pf_file)

{gamspy-1.18.4 → gamspy-1.19.1}/src/gamspy/_backend/local.py

@@ -38,10 +38,10 @@ class Local(backend.Backend):
             load_symbols,
         )
 
-    def _prepare_extra_options(self, gams_to_gamspy: bool) -> dict:
+    def _prepare_hidden_options(self, gams_to_gamspy: bool) -> dict:
         scrdir = self.container._process_directory
 
-        extra_options = {
+        hidden_options = {
             "trace": self.trace_file,
             "input": self.gms_file,
             "output": self.lst_file,
@@ -53,13 +53,13 @@ class Local(backend.Backend):
         }
 
         if gams_to_gamspy:
-            extra_options["gdx"] = self.container._gdx_out
-            extra_options["gdxSymbols"] = "newOrChanged"
+            hidden_options["gdx"] = self.container._gdx_out
+            hidden_options["gdxSymbols"] = "newOrChanged"
 
         if self.container._network_license:
-            extra_options["netlicense"] = os.path.join(scrdir, "gamslice.dat")
+            hidden_options["netlicense"] = os.path.join(scrdir, "gamslice.dat")
 
-        return extra_options
+        return hidden_options
 
     def is_async(self):
         return False
@@ -86,8 +86,8 @@ class Local(backend.Backend):
             gams_file.write(gams_string)
 
         # Write pf file
-        extra_options = self._prepare_extra_options(gams_to_gamspy)
-        self.options._set_extra_options(extra_options)
+        hidden_options = self._prepare_hidden_options(gams_to_gamspy)
+        self.options._set_hidden_options(hidden_options)
         self.options._export(self.pf_file, self.output)
 
         try: