from __future__ import annotations
import atexit
import os
import platform
import re
import shutil
import signal
import sys
import tempfile
import threading
import traceback
import weakref
from pathlib import Path
from typing import TYPE_CHECKING, TextIO
import gams.transfer as gt
import gamspy as gp
import gamspy._miro as miro
import gamspy._validation as validation
import gamspy.utils as utils
from gamspy._backend.backend import backend_factory
from gamspy._communication import close_connection, get_connection, open_connection
from gamspy._config import get_option
from gamspy._extrinsic import ExtrinsicLibrary
from gamspy._miro import MiroJSONEncoder
from gamspy._model import Problem, Sense
from gamspy._workspace import Workspace
from gamspy.exceptions import ValidationError
if TYPE_CHECKING:
from collections.abc import Iterable, Sequence
from typing import Any, Literal, TypeAlias
from pandas import DataFrame
from gamspy import (
Alias,
Equation,
EquationType,
Model,
Parameter,
Set,
UniverseAlias,
Variable,
)
from gamspy._algebra.expression import Expression
from gamspy._algebra.operation import Operation
from gamspy._options import Options
from gamspy._symbols.implicits import ImplicitVariable
from gamspy._symbols.symbol import Symbol
from gamspy.math.matrix import Dim
SymbolType: TypeAlias = Set | Alias | Parameter | Variable | Equation
LOOPBACK = "127.0.0.1"
IS_MIRO_INIT = os.getenv("MIRO", False)
MIRO_GDX_IN = os.getenv("GAMS_IDC_GDX_INPUT", None)
MIRO_GDX_OUT = os.getenv("GAMS_IDC_GDX_OUTPUT", None)
is_windows = platform.system() == "Windows"
def add_sysdir_to_path(system_directory: str) -> None:
if is_windows:
if "PATH" in os.environ:
if not os.environ["PATH"].startswith(system_directory + os.pathsep):
os.environ["PATH"] = system_directory + os.pathsep + os.environ["PATH"]
else:
os.environ["PATH"] = system_directory
def get_system_directory(system_directory: str | os.PathLike | None) -> str:
if isinstance(system_directory, os.PathLike):
system_directory = os.fspath(system_directory)
if system_directory is not None:
return system_directory
return get_option("GAMS_SYSDIR")
def get_options_file_name(solver: str, file_number: int) -> str:
"""
Generates the option file name according to the `optfile` rules of GAMS.
Here are the rules:
1: solver.opt
2-9: solver.op<file_number>
10-99: solver.o<file_number>
>100: solver.<file_number>
"""
if file_number == 1:
options_file_name = f"{solver}.opt"
elif file_number >= 2 and file_number <= 9:
options_file_name = f"{solver}.op{file_number}"
elif file_number >= 10 and file_number <= 99:
options_file_name = f"{solver}.o{file_number}"
else:
options_file_name = f"{solver}.{file_number}"
return options_file_name
[docs]
class Container(gt.Container):
"""
Central workspace for building, modifying, executing, and exchanging data
with GAMS models.
https://gamspy.readthedocs.io/en/latest/reference/gamspy._container.html
A :class:`Container` owns all GAMSPy symbols (sets, parameters, variables,
equations, models) and manages synchronization with the GAMS execution
engine.
A container can:
* Create and store symbols
* Load symbols and records from GDX/G00 files
* Synchronize modified symbols with GAMS
* Generate and persist GAMS code and data files
* Act as a context manager.
Parameters
----------
load_from : str, os.PathLike, Container, gt.Container, optional
Source to initialize the container from:
* ``.gdx`` file: loads symbols and records from a GDX file.
* ``.g00`` file: restarts from a GAMS save file.
* Container: Copies symbols from the given container into the new container.
system_directory : str, os.PathLike, optional
Path to the directory that holds the GAMS installation, by default None
working_directory : str, os.PathLike, optional
Directory used for temporary files (``.gms``, ``.lst``, ``.gdx``).
If omitted, a temporary directory is created.
debugging_level : {"keep", "keep_on_error", "delete"}, optional
Controls whether temporary files are retained:
* ``"keep"``: Keep files and generated GAMS code.
* ``"keep_on_error"``: Keep files only on errors (default).
* ``"delete"``: Always clean up.
options : Options, optional
Global options for the overall execution
output : TextIO, optional
Stream to which GAMS output is written.
Examples
--------
Basic usage
>>> import gamspy as gp
>>> m = gp.Container()
>>> i = gp.Set(m, "i", records=["i1", "i2"])
Loading from an existing GDX
>>> m.write("data.gdx")
>>> m2 = gp.Container(load_from="data.gdx")
>>> list(m2.data.keys()) == list(m.data.keys())
True
Using as a context manager
>>> with gp.Container() as m:
... i = gp.Set(m, "i")
... j = gp.Set(m, "j", domain=i)
"""
def __init__(
self,
load_from: str | os.PathLike | Container | gt.Container | None = None,
system_directory: str | os.PathLike | None = None,
working_directory: str | os.PathLike | None = None,
debugging_level: Literal["keep", "keep_on_error", "delete"] = "keep_on_error",
options: Options | None = None,
output: TextIO | None = None,
):
self._comm_pair_id = utils._get_unique_name()
self.output = output
self._gams_string = ""
self._in_loop: int = 0
self.models: dict[str, Model] = {}
self._mpsge_models: list[str] = []
if IS_MIRO_INIT:
atexit.register(self._write_miro_files)
system_directory = get_system_directory(system_directory)
add_sysdir_to_path(system_directory)
self._unsaved_statements: list = []
super().__init__(system_directory=system_directory)
self._options = validation.validate_global_options(options)
if self._options.license is not None:
self._license_path = self._options.license
else:
self._license_path = utils._get_license_path(self.system_directory)
self._network_license = self._is_network_license()
self._debugging_level = debugging_level
self._workspace = Workspace(debugging_level, working_directory)
self._working_directory = self._workspace.working_directory
self._process_directory = tempfile.mkdtemp(dir=self.working_directory)
self._job, self._gdx_in, self._gdx_out = self._setup_paths()
self._temp_container = gt.Container(system_directory=self.system_directory)
# needed for miro
self._miro_input_symbols: list[str] = []
self._miro_output_symbols: list[str] = []
open_connection(self)
weakref.finalize(self, close_connection, self._comm_pair_id)
self._is_restarted = False
if load_from is not None:
if isinstance(load_from, os.PathLike):
load_from = os.fspath(load_from)
if not isinstance(load_from, (str, gt.Container)):
raise ValidationError(
f"`load_from` must be of type str or Container but found {type(load_from)}"
)
if isinstance(load_from, str) and load_from[-4:] not in (
".gdx",
".g00",
):
raise ValidationError(
f"`load_from` must end with .gdx or .g00 but found {load_from}"
)
if isinstance(load_from, str) and load_from.endswith(".g00"):
self._options._set_extra_options(
{"restart": load_from, "gdxSymbols": "all"}
)
self._synch_with_gams(gams_to_gamspy=True)
self._options._set_extra_options({})
self._clean_modified_symbols()
self._unsaved_statements = []
self._is_restarted = True
else:
self._read(load_from)
if not isinstance(load_from, gt.Container):
self._unsaved_statements = []
self._clean_modified_symbols()
self._add_statement(f"$declareAndLoad {load_from}")
self._synch_with_gams()
def __enter__(self):
pid = os.getpid()
tid = threading.get_native_id()
gp._ctx_managers[(pid, tid)] = self
return self
def __exit__(self, exc_type, exc_val, exc_tb):
pid = os.getpid()
tid = threading.get_native_id()
try:
del gp._ctx_managers[(pid, tid)]
except KeyError:
...
def __repr__(self) -> str:
return f"Container(system_directory='{self.system_directory}', working_directory='{self.working_directory}', debugging_level='{self._debugging_level}')"
def __str__(self):
if len(self):
return f"<Container ({hex(id(self))}) with {len(self)} symbols: {self.data.keys()}>"
return f"<Empty Container ({hex(id(self))})>"
@property
def working_directory(self) -> str:
"""
Absolute path of the working directory used by this container.
The directory contains generated GAMS input/output files such as
``.gms``, ``.lst``, ``.gdx`` and temporary scratch files.
Returns
-------
str
Examples
--------
>>> import gamspy as gp
>>> m = gp.Container()
>>> m.working_directory # doctest: +ELLIPSIS
'...'
"""
return self._working_directory
@property
def in_miro(self) -> bool:
"""
Indicates whether the container is executed inside a GAMS MIRO context.
When running under MIRO, input data is typically provided by MIRO itself.
This flag can be used to skip expensive or redundant data-loading steps
(e.g., reading Excel files).
Returns
-------
bool
Examples
--------
>>> import gamspy as gp
>>> m = gp.Container()
>>> if not m.in_miro:
... pass # e.g. load data from files
"""
return MIRO_GDX_IN is not None
def _is_network_license(self) -> bool:
with open(self._license_path, encoding="utf-8") as file:
lines = file.readlines()
return bool(lines[0][54] == "+" and lines[4][47] == "N")
def _get_symbol_name(self, prefix: str) -> str:
use_py_var_name = get_option("USE_PY_VAR_NAME")
if use_py_var_name == "no":
name = prefix + utils._get_unique_name() + "gpauto"
elif use_py_var_name == "yes":
name = utils._get_name_from_stack()
elif use_py_var_name == "yes-or-autogenerate":
try:
name = utils._get_name_from_stack()
# if a symbol with the same name exists, autogenerate.
try:
_ = self[name]
name = prefix + utils._get_unique_name() + "gpauto"
except KeyError:
...
except ValidationError:
name = prefix + utils._get_unique_name() + "gpauto"
else:
raise ValidationError(
f'Invalid value `{use_py_var_name}` for `USE_PY_VAR_NAME`. Possible values are "no", "yes", "yes-or-autogenerate"'
)
return name
def _interrupt(self) -> None:
_, process = get_connection(self._comm_pair_id)
if platform.system() == "Windows":
os.kill(process.pid, signal.CTRL_C_EVENT)
else:
os.kill(process.pid, signal.SIGINT)
def _write_miro_files(self):
# create conf_<model>/<model>_io.json
try:
encoder = MiroJSONEncoder(self)
encoder.write_json()
except Exception:
close_connection(self._comm_pair_id)
traceback.print_exc(file=sys.stderr)
os._exit(1)
def _add_statement(self, statement) -> None:
self._unsaved_statements.append(statement)
def _cast_symbols(self, symbol_names: list[str] | None = None) -> None:
"""Casts GTP symbols to GAMSPy symbols"""
symbol_names = symbol_names if symbol_names else list(self.data.keys())
for symbol_name in symbol_names:
gtp_symbol = self.data[symbol_name]
new_domain = [
(self.data[member.name] if type(member) is not str else member)
for member in gtp_symbol.domain
]
del self.data[symbol_name]
if isinstance(gtp_symbol, gt.Alias):
alias_with = self.data[gtp_symbol.alias_with.name]
_ = gp.Alias._constructor_bypass(self, gtp_symbol._name, alias_with)
elif isinstance(gtp_symbol, gt.UniverseAlias):
_ = gp.UniverseAlias._constructor_bypass(
self,
gtp_symbol._name,
)
elif isinstance(gtp_symbol, gt.Set):
_ = gp.Set._constructor_bypass(
self,
gtp_symbol._name,
new_domain,
gtp_symbol._is_singleton,
gtp_symbol._records,
gtp_symbol._description,
)
elif isinstance(gtp_symbol, gt.Parameter):
_ = gp.Parameter._constructor_bypass(
self,
gtp_symbol._name,
new_domain,
gtp_symbol._records,
gtp_symbol._description,
)
elif isinstance(gtp_symbol, gt.Variable):
_ = gp.Variable._constructor_bypass(
self,
gtp_symbol._name,
gtp_symbol._type,
new_domain,
gtp_symbol._records,
gtp_symbol._description,
)
elif isinstance(gtp_symbol, gt.Equation):
symbol_type = gtp_symbol.type
if gtp_symbol.type in ("eq", "leq", "geq"):
symbol_type = "regular"
_ = gp.Equation._constructor_bypass(
self,
gtp_symbol._name,
symbol_type,
new_domain,
gtp_symbol._records,
gtp_symbol._description,
)
def _delete_autogenerated_symbols(self) -> None:
"""
Removes autogenerated model attributes, objective variable and equation from
the container
"""
autogenerated_symbol_names = self._get_autogenerated_symbol_names()
for name in autogenerated_symbol_names:
if name in self.data:
del self.data[name]
def _setup_paths(self) -> tuple[str, str, str]:
suffix = "_" + utils._get_unique_name()
job = os.path.join(self.working_directory, suffix)
gdx_in = f"{job}in.gdx"
gdx_out = f"{job}out.gdx"
return job, gdx_in, gdx_out
def _get_autogenerated_symbol_names(self) -> list[str]:
names = []
for name in self.data:
if name.startswith(gp.Model._generate_prefix):
names.append(name)
return names
def _get_modified_symbols(self) -> list[str]:
modified_names = []
for name, symbol in self:
if symbol._modified:
if (
type(symbol) is gp.Alias
and symbol.alias_with.name not in modified_names # type: ignore
):
modified_names.append(symbol.alias_with.name) # type: ignore
modified_names.append(name)
return modified_names
def _clean_modified_symbols(self) -> None:
for symbol in self.data.values():
if type(symbol) is gp.Alias:
symbol.alias_with.modified = False # type: ignore
symbol.modified = False
def _synch_with_gams(
self,
relaxed_domain_mapping: bool = False,
gams_to_gamspy: bool = False,
load_symbols: list[Symbol] | None = None,
) -> DataFrame | None:
if self._in_loop:
return None
runner = backend_factory(
self, self._options, output=self.output, load_symbols=load_symbols
)
summary = runner.run(relaxed_domain_mapping, gams_to_gamspy)
if self._options and self._options.seed is not None:
# Required for correct seeding. Seed can only be set in the first run.
self._options.seed = None
if IS_MIRO_INIT:
miro._write_default_gdx_miro(self)
return summary
def _generate_gams_string(self, gdx_in: str, modified_names: list[str]) -> str:
LOADABLE = (gp.Set, gp.Parameter, gp.Variable, gp.Equation)
MIRO_INPUT_TYPES = (gp.Set, gp.Parameter)
assume_suffix = int(get_option("ASSUME_VARIABLE_SUFFIX"))
strings = ["$onMultiR", "$onUNDF"]
if assume_suffix == 1:
strings.append("$onDotL")
elif assume_suffix == 2:
strings.append("$onDotScale")
for statement in self._unsaved_statements:
if type(statement) is str:
strings.append(statement)
else:
strings.append(statement.getDeclaration())
if modified_names:
loadables = []
for name in modified_names:
symbol = self[name]
if (
type(symbol) in LOADABLE
and not name.startswith(gp.Model._generate_prefix)
and symbol.synchronize
):
loadables.append(symbol)
if loadables:
strings.append(f"$gdxIn {gdx_in}")
for loadable in loadables:
if (
type(loadable) in MIRO_INPUT_TYPES
and loadable._is_miro_input
and not IS_MIRO_INIT
and MIRO_GDX_IN
):
miro_load = miro.get_load_input_str(loadable.name, gdx_in)
strings.append(miro_load)
else:
strings.append(f"$loadDC {loadable.name}")
strings.append("$gdxIn")
if assume_suffix == 1:
strings.append("$offDotL")
elif assume_suffix == 2:
strings.append("$offDotScale")
strings.extend(["$offUNDF", "$offMulti"])
if not IS_MIRO_INIT and MIRO_GDX_OUT:
if len(self._miro_output_symbols) == 0:
self.write(MIRO_GDX_OUT, symbol_names=[])
else:
strings.append(miro.get_unload_output_str(self))
gams_string = "\n".join(strings)
if self._debugging_level == "keep":
self._gams_string += gams_string + "\n"
return gams_string
def _filter_load_symbols(
self, symbol_names: dict[str, str] | list[str]
) -> dict[str, str] | list[str]:
if isinstance(symbol_names, list):
names = []
for name in symbol_names:
if name in self.data:
symbol = self[name]
if not isinstance(symbol, gt.Alias) and symbol.synchronize:
names.append(name)
else:
names.append(name)
return names
mapping = {}
for gdx_name, gamspy_name in symbol_names.items():
if gamspy_name in self.data:
if self[gamspy_name].synchronize:
mapping[gdx_name] = gamspy_name
else:
raise ValidationError(
f"Invalid renaming. `{gamspy_name}` does not exist in the container."
)
return mapping
def _load_records_from_gdx(self, load_from: str, names: Iterable[str]) -> None:
self._temp_container.read(load_from, names)
original_state = self._options.miro_protect
self._options.miro_protect = False
for name in names:
if name in self.data:
updated_records = self._temp_container[name].records
self[name].records = updated_records
self[name].domain_labels = self[name].domain_names
else:
self._read(load_from, [name])
self._options.miro_protect = original_state
self._temp_container.data = {}
def _load_records_with_rename(self, load_from: str, names: dict[str, str]) -> None:
self._temp_container.read(load_from, list(names.keys()))
original_state = self._options.miro_protect
self._options.miro_protect = False
for gdx_name, gamspy_name in names.items():
updated_records = self._temp_container[gdx_name].records
self[gamspy_name].records = updated_records
self[gamspy_name].domain_labels = self[gamspy_name].domain_names
self._options.miro_protect = original_state
self._temp_container.data = {}
def _read(
self,
load_from: str | Container | gt.Container,
symbol_names: list[str] | None = None,
load_records: bool = True,
mode: str | None = None,
encoding: str | None = None,
) -> None:
super().read(load_from, symbol_names, load_records, mode, encoding)
self._cast_symbols(symbol_names)
[docs]
def read(
self,
load_from: str | os.PathLike | Container | gt.Container,
symbol_names: list[str] | None = None,
load_records: bool = True,
mode: str | None = None,
encoding: str | None = None,
) -> None:
"""
Read symbols and records from a GDX file or another container.
Parameters
----------
load_from : str | os.PathLike | Container | gt.Container
Source to read from.
symbol_names : list[str], optional
Names of symbols to read. If omitted, all symbols are read.
load_records : bool, optional
Whether to load symbol records (default: True).
mode : str, optional
GDX read mode ("category", or "string", default: "category").
encoding : str, optional
Text encoding for symbol metadata.
Examples
--------
>>> import gamspy as gp
>>> m = gp.Container()
>>> i = gp.Set(m, "i", records=["a", "b"])
>>> m.write("example.gdx")
>>> m2 = gp.Container()
>>> m2.read("example.gdx")
>>> "i" in m2.data
True
Reading selected symbols only
>>> m2 = gp.Container()
>>> m2.read("example.gdx", symbol_names=["i"])
"""
if isinstance(load_from, os.PathLike):
load_from = os.fspath(load_from)
self._read(load_from, symbol_names, load_records, mode, encoding)
self._synch_with_gams()
[docs]
def setRecords(
self, records: dict[SymbolType, Any], *, uels_on_axes: bool | list[bool] = False
) -> None:
"""
Set records for multiple symbols in a single batch operation.
This is functionally equivalent to calling ``symbol.setRecords`` for
each symbol, but triggers only one synchronization with GAMS.
Parameters
----------
records : dict[SymbolType, Any]
Mapping from symbols to their new records.
uels_on_axes : bool | list[bool], optional
Whether domain labels (UELs) are stored on pandas axes. Either a single
boolean applied to all symbols, or a list matching ``records`` order.
Raises
------
ValidationError
If ``uels_on_axes`` length does not match ``records`` length.
Examples
--------
>>> import gamspy as gp
>>> m = gp.Container()
>>> i = gp.Set(m, "i")
>>> j = gp.Set(m, "j")
>>> m.setRecords({i: ["a", "b"], j: [1, 2, 3]})
"""
if not isinstance(uels_on_axes, list):
uels_on_axes = [uels_on_axes] * len(records)
if len(uels_on_axes) != len(records):
raise ValidationError(
f"Length of `records` and `uels_on_axes` must match. Size of records: {len(records)}, size of uels_on_axes: {len(uels_on_axes)}"
)
for item, uels_on_axe in zip(records.items(), uels_on_axes, strict=False):
symbol, record = item
symbol._setRecords(record, uels_on_axes=uels_on_axe)
self._synch_with_gams()
[docs]
def write(
self,
write_to: str,
symbol_names: list[str] | None = None,
compress: bool = False,
mode: str | None = None,
eps_to_zero: bool = True,
) -> None:
"""
Write symbols and records to a GDX file.
Parameters
----------
write_to : str
Target GDX file path.
symbol_names : list[str], optional
Symbols to write. If omitted, all symbols are written.
compress : bool, optional
Whether to compress the GDX file.
mode : str, optional
Write mode (passed to GAMS Transfer).
eps_to_zero : bool, optional
Convert EPS values to zero before writing.
Examples
--------
>>> import gamspy as gp
>>> m = gp.Container()
>>> i = gp.Set(m, "i", records=["x", "y"])
>>> m.write("out.gdx")
"""
super().write(
write_to,
symbol_names,
compress,
mode=mode,
eps_to_zero=eps_to_zero,
)
[docs]
def writeSolverOptions(
self, solver: str, solver_options: dict | str | Path, file_number: int = 1
) -> None:
"""
Writes solver options of the specified solver to the working directory.
Parameters
----------
solver : str
Name of the solver.
solver_options : dict | str | Path
Options of the specified solver or path to an existing solver options file.
file_number : int
Solver option file number. Equivalent to optfile option of GAMS. See https://gams.com/latest/docs/UG_GamsCall.html#GAMSAOoptfile for more details.
Examples
--------
>>> import gamspy as gp
>>> m = gp.Container()
>>> m.writeSolverOptions("conopt", solver_options={"rtmaxv": "1.e12"})
"""
if file_number < 1:
raise ValidationError(
f"The smallest number `file_number` can get is 1 but received {file_number}"
)
if solver.lower() == "conopt":
solver = "conopt4"
options_file_name = os.path.join(
self.working_directory, get_options_file_name(solver, file_number)
)
if isinstance(solver_options, (str, Path)):
path = Path(solver_options)
shutil.copy2(path, options_file_name)
else:
with open(options_file_name, "w", encoding="utf-8") as solver_file:
for key, value in solver_options.items():
row = f"{key} {value}\n"
if solver.upper() in ("SHOT", "SOPLEX", "SCIP", "HIGHS"):
row = f"{key} = {value}\n"
solver_file.write(row)
# The following solvers do not use the opt<solver>.def file
if solver.upper() in (
"HIGHS",
"SOPLEX",
"KESTREL",
"SCIP",
"SHOT",
"SOPLEX",
):
return
if get_option("VALIDATION") and get_option("SOLVER_OPTION_VALIDATION"):
validation.validate_solver_options(
self.system_directory, options_file_name, solver
)
[docs]
def generateGamsString(
self, path: str | None = None, *, show_raw: bool = False
) -> str:
"""
Return the generated GAMS code executed by this container.
Only available when ``debugging_level='keep'`` was specified at
container creation time.
Parameters
----------
path : str, optional
File path to write the generated GAMS code to.
show_raw : bool, optional
If True, strips data-loading and auxiliary statements, leaving
the core model formulation.
Returns
-------
str
Generated GAMS code.
Raises
------
ValidationError
If debugging level is not ``"keep"``.
Examples
--------
>>> import gamspy as gp
>>> m = gp.Container(debugging_level="keep")
>>> i = gp.Set(m, "i")
>>> gams = m.generateGamsString()
"""
if self._debugging_level != "keep":
raise ValidationError(
"`debugging_level` argument of the container must be set to 'keep' to use this function."
)
gams_string = self._gams_string
if show_raw:
gams_string = utils._filter_gams_string(self._gams_string)
if path:
with open(path, "w") as file:
file.write(gams_string)
return gams_string
[docs]
def loadRecordsFromGdx(
self,
load_from: str | Path,
symbol_names: Iterable[str] | dict[str, str] | None = None,
) -> None:
"""
Loads data of the given symbols from a GDX file. If no
symbol names are given, data of all symbols are loaded.
Parameters
----------
load_from : str
Path to the GDX file
symbol_names : Iterable[str], dict[str, str], optional
Symbol names whose data will be load from GDX, by default None.
Default option loads records of all symbols in the GDX file.
If given as a dict, keys are the symbol names in the GDX file, and
values are the names of the GAMSPy symbols.
Examples
--------
>>> from gamspy import Container, Set
>>> m = Container()
>>> i = Set(m, "i", records=["i1", "i2"])
>>> m.write("test.gdx")
>>> m2 = Container()
>>> i = Set(m2, "i")
>>> m2.loadRecordsFromGdx("test.gdx")
>>> print(i.records.equals(m2["i"].records))
True
"""
if isinstance(load_from, Path):
load_from = str(load_from.resolve())
if symbol_names is None:
# If no symbol names are given, all records in the gdx should be loaded
symbol_names = utils._get_symbol_names_from_gdx(
self.system_directory, load_from
)
self._add_statement(f"$declareAndLoad {load_from}")
symbol_names = self._filter_load_symbols(symbol_names) # type: ignore
self._load_records_from_gdx(load_from, symbol_names)
self._synch_with_gams()
return
if isinstance(symbol_names, (list, dict)):
symbol_names = self._filter_load_symbols(symbol_names)
else:
raise TypeError("`symbol_names` must be either a list or a dictionary.")
if isinstance(symbol_names, dict):
self._load_records_with_rename(load_from, symbol_names)
else:
self._load_records_from_gdx(load_from, symbol_names)
self._synch_with_gams()
[docs]
def addGamsCode(self, gams_code: str) -> None:
"""
Adds an arbitrary GAMS code to the generate .gms file.
Using addGAMSCode might result in a license error if no GAMSpy++ license is used.
Parameters
----------
gams_code : str
GAMS code that you want to insert.
Examples
--------
>>> from gamspy import Container
>>> m = Container()
>>> m.addGamsCode("scalar piHalf / [pi/2] /;")
>>> m["piHalf"].toValue()
np.float64(1.5707963267948966)
"""
self._add_statement(gams_code)
self._synch_with_gams(relaxed_domain_mapping=True, gams_to_gamspy=True)
for _, symbol in self:
symbol.modified = False
# Unfortunately MPSGE requires a dirty trick
pattern = re.compile(r"^\$sysInclude\s+mpsgeset\s+(\w+)\s*$", re.MULTILINE)
match = pattern.search(gams_code)
if match:
model_name = match.group(1)
self._mpsge_models.append(model_name.lower())
self._unsaved_statements = []
[docs]
def close(self) -> None:
"""
Close the connection to the GAMS execution engine and release resources.
After calling this method, the container must not be used for further
model execution or data synchronization. Symbol data remains accessible
for read-only inspection.
Examples
--------
>>> import gamspy as gp
>>> m = gp.Container() # Starts running the GAMS execution engine.
>>> m.close() # Closes the connection to the execution engine.
"""
close_connection(self._comm_pair_id)
[docs]
def addAlias(
self,
name: str | None = None,
alias_with: Set | Alias = None, # type: ignore
) -> Alias:
"""
Creates a new Alias and adds it to the container
Parameters
----------
name : str, optional
Name of the alias.
alias_with : Set | Alias
Alias set object.
Returns
-------
Alias
Raises
------
TypeError
In case the alias_with is different than a Set or an Alias
ValueError
If there is symbol with same name but different type in the
Container
Examples
--------
>>> import gamspy as gp
>>> m = gp.Container()
>>> i = m.addSet("i")
>>> a = m.addAlias("a", i)
"""
if name is None:
name = self._get_symbol_name(prefix="a")
return gp.Alias(self, name, alias_with)
[docs]
def addUniverseAlias(self, name: str | None = None) -> UniverseAlias:
"""
Creates a new UniverseAlias and adds it to the container
Parameters
----------
name : str, optional
Name of the universe alias.
Returns
-------
UniverseAlias
Raises
------
ValueError
If there is symbol with same name but different type in the
Container
Examples
--------
>>> import gamspy as gp
>>> m = gp.Container()
>>> a = m.addUniverseAlias("a")
"""
if name is None:
name = self._get_symbol_name(prefix="u")
return gp.UniverseAlias(self, name)
[docs]
def addSet(
self,
name: str | None = None,
domain: Sequence[Set | Alias | str] | Set | Alias | str | None = None,
is_singleton: bool = False,
records: Any | None = None,
domain_forwarding: bool | list[bool] = False,
description: str = "",
uels_on_axes: bool = False,
is_miro_input: bool = False,
is_miro_output: bool = False,
) -> Set:
"""
Creates a Set and adds it to the container.
Parameters
----------
name : str, optional
Name of the set. If omitted, a unique name is generated.
domain : Sequence[Set | Alias | str] | Set | Alias | str, optional
Domain over which the set is defined.
is_singleton : bool, optional
If True, the set may contain at most one element.
records : pd.DataFrame | np.ndarray | list, optional
Initial elements of the set.
domain_forwarding : bool | list[bool], optional
Enable domain forwarding.
description : str, optional
Human-readable description.
uels_on_axes : bool
Assume that symbol domain information is contained in the axes of the given records.
is_miro_input : bool
Whether the symbol is a GAMS MIRO input symbol. See: https://gams.com/miro/tutorial.html
is_miro_output : bool
Whether the symbol is a GAMS MIRO output symbol. See: https://gams.com/miro/tutorial.html
Returns
-------
Set
Raises
------
err
In case arguments are not valid
ValueError
When there is symbol with same name in the
Container
Examples
--------
Simple set:
>>> import gamspy as gp
>>> m = gp.Container()
>>> i = m.addSet("i", records=["a", "b"])
Indexed set:
>>> j = m.addSet("j", domain=i)
Singleton set:
>>> s = m.addSet("s", is_singleton=True, records=["s1"])
"""
if name is None:
name = self._get_symbol_name(prefix="s")
return gp.Set(
self,
name,
domain,
is_singleton,
records,
domain_forwarding,
description,
uels_on_axes,
is_miro_input=is_miro_input,
is_miro_output=is_miro_output,
)
[docs]
def addParameter(
self,
name: str | None = None,
domain: Sequence[Set | Alias | str] | Set | Alias | Dim | str | None = None,
records: Any | None = None,
domain_forwarding: bool | list[bool] = False,
description: str = "",
uels_on_axes: bool = False,
is_miro_input: bool = False,
is_miro_output: bool = False,
is_miro_table: bool = False,
) -> Parameter:
"""
Creates a Parameter and adds it to the Container
Parameters
----------
name : str, optional
Name of the parameter. If omitted, a unique name is generated.
domain : Sequence[Set | Alias | str] | Set | Alias | Dim | str, optional
Domain over which the parameter is defined.
records : int | float | pd.DataFrame | np.ndarray | list, optional
Records of the parameter.
domain_forwarding : bool | list[bool], optional
Whether the parameter forwards the domain.
description : str, optional
Human-readable description.
uels_on_axes : bool
Assume that symbol domain information is contained in the axes of the given records.
is_miro_input : bool
Whether the symbol is a GAMS MIRO input symbol. See: https://gams.com/miro/tutorial.html
is_miro_output : bool
Whether the symbol is a GAMS MIRO output symbol. See: https://gams.com/miro/tutorial.html
is_miro_table : bool
Whether the symbol is a GAMS MIRO table symbol. See: https://gams.com/miro/tutorial.html
Returns
-------
Parameter
Raises
------
err
In case arguments are not valid
ValueError
If there is symbol with same name but different type in the
Container
Examples
--------
>>> import gamspy as gp
>>> m = gp.Container()
>>> a = m.addParameter("a")
"""
if name is None:
name = self._get_symbol_name(prefix="p")
return gp.Parameter(
self,
name,
domain,
records,
domain_forwarding,
description,
uels_on_axes,
is_miro_input=is_miro_input,
is_miro_output=is_miro_output,
is_miro_table=is_miro_table,
)
[docs]
def addVariable(
self,
name: str | None = None,
type: str = "free",
domain: Sequence[Set | Alias | str] | Set | Alias | Dim | str | None = None,
records: Any | None = None,
domain_forwarding: bool | list[bool] = False,
description: str = "",
uels_on_axes: bool = False,
is_miro_output: bool = False,
) -> Variable:
"""
Creates a Variable and adds it to the Container
Parameters
----------
name : str, optional
Name of the variable. If omitted, a unique name is generated.
type : str, optional
Type of the variable. "free" by default.
domain : Sequence[Set | Alias | str] | Set | Alias | Dim | str, optional
Domain of the variable.
records : Any, optional
Records of the variable.
domain_forwarding : bool | list[bool], optional
Whether the variable forwards the domain.
description : str, optional
Description of the variable.
is_miro_output : bool
Whether the symbol is a GAMS MIRO output symbol. See: https://gams.com/miro/tutorial.html
Returns
-------
Variable
Raises
------
err
In case arguments are not valid
ValueError
If there is symbol with same name but different type in the
Container
Examples
--------
>>> import gamspy as gp
>>> m = gp.Container()
>>> v = m.addVariable("v")
"""
if name is None:
name = self._get_symbol_name(prefix="v")
return gp.Variable(
self,
name,
type,
domain,
records,
domain_forwarding,
description,
uels_on_axes,
is_miro_output=is_miro_output,
)
[docs]
def addEquation(
self,
name: str | None = None,
type: str | EquationType = "regular",
domain: Sequence[Set | Alias] | Set | Alias | None = None,
definition: Variable | Operation | Expression | None = None,
records: Any | None = None,
domain_forwarding: bool | list[bool] = False,
description: str = "",
uels_on_axes: bool = False,
is_miro_output: bool = False,
definition_domain: list | None = None,
) -> Equation:
"""
Creates an Equation and adds it to the Container
Parameters
----------
name : str, optional
Name of the equation. If omitted, a unique name is generated.
type : str
Type of the equation. "regular" by default.
domain : Sequence[Set | Alias] | Set | Alias, optional
Domain of the variable.
definition: Expression, optional
Definition of the equation.
records : Any, optional
Records of the equation.
domain_forwarding : bool | list[bool], optional
Whether the equation forwards the domain.
description : str, optional
Description of the equation.
uels_on_axes: bool
Assume that symbol domain information is contained in the axes of the given records.
definition_domain: list, optional
Definiton domain of the equation.
is_miro_output : bool
Whether the symbol is a GAMS MIRO output symbol. See: https://gams.com/miro/tutorial.html
Returns
-------
Equation
Raises
------
err
In case arguments are not valid
ValueError
If there is symbol with same name but different type in the
Container
Examples
--------
>>> import gamspy as gp
>>> m = gp.Container()
>>> i = m.addEquation("i")
"""
if name is None:
name = self._get_symbol_name(prefix="e")
return gp.Equation(
self,
name,
type,
domain,
definition,
records,
domain_forwarding,
description,
uels_on_axes,
is_miro_output,
definition_domain,
)
[docs]
def addModel(
self,
name: str | None = None,
description: str = "",
problem: Problem | str = Problem.MIP,
equations: Sequence[Equation] = [],
sense: Sense | str = Sense.FEASIBILITY,
objective: Variable | Expression | None = None,
matches: dict[
Equation | Sequence[Equation],
Variable | Sequence[Variable],
]
| None = None,
limited_variables: Sequence[ImplicitVariable] | None = None,
external_module: str | None = None,
) -> Model:
"""
Creates a Model and adds it to the Container
Parameters
----------
name : str, optional
Name of the model. If omitted, a unique name is generated.
description : str, optional
Description of the model.
equations : Sequence[Equation]
Sequence of Equation objects.
problem : Problem or str, optional
'LP', 'NLP', 'QCP', 'DNLP', 'MIP', 'RMIP', 'MINLP', 'RMINLP', 'MIQCP', 'RMIQCP', 'MCP', 'CNS', 'MPEC', 'RMPEC', 'EMP', or 'MPSGE',
by default Problem.LP.
sense : Sense, optional
"MIN", "MAX", or "FEASIBILITY".
objective : Variable | Expression, optional
Objective variable to minimize or maximize or objective itself.
matches : dict[Equation | Sequence[Equation], Variable | Sequence[Variable]], optional
Equation - Variable matches for MCP models.
limited_variables : Sequence[ImplicitVariable], optional
Allows limiting the domain of variables used in a model.
external_module: str, optional
The name of the external module in which the external equations are implemented
Returns
-------
Model
Examples
--------
>>> import gamspy as gp
>>> m = gp.Container()
>>> x = gp.Variable(m, "x")
>>> e = gp.Equation(m, "e", definition=x >= 1)
>>> model = m.addModel(name="demo", equations=[e], problem="LP", sense="MIN", objective=x)
"""
if name is None:
name = self._get_symbol_name(prefix="m")
return gp.Model(
self,
name,
description,
problem,
equations,
sense,
objective,
matches,
limited_variables,
external_module=external_module,
)
[docs]
def copy(self, working_directory: str) -> Container:
"""
Creates a copy of the Container. Should not be invoked after
creating the model.
Parameters
----------
working_directory : str, optional
Working directory of the new Container, by default None
Returns
-------
Container
Raises
------
ValidationError
Examples
--------
>>> import gamspy as gp
>>> m = gp.Container()
>>> i = gp.Set(m, "i")
>>> new_cont = m.copy(working_directory="test")
>>> new_cont.data.keys() == m.data.keys()
True
"""
os.makedirs(working_directory, exist_ok=True)
m = Container(working_directory=working_directory)
if m.working_directory == self.working_directory:
raise ValidationError(
"Copy of a container cannot have the same working directory"
" with the original container."
)
self.write(m._job + "in.gdx")
m._read(m._job + "in.gdx")
# if already defined equations exist, add them to .gms file
for equation in self.getEquations():
if equation._definition is not None:
m._add_statement(equation._definition)
m[equation.name]._definition = equation._definition
m._synch_with_gams()
return m
[docs]
def serialize(self, path: str) -> None:
"""
Serializes the Container into a zip file.
Parameters
----------
path : str
Path to the zip file.
Examples
--------
>>> import gamspy as gp
>>> m = gp.Container()
>>> i = gp.Set(m, "i", records=range(3))
>>> gp.serialize(m, "serialization_path.zip")
"""
gp.serialize(self, path)
[docs]
def getEquations(self) -> list[Equation]:
"""
Returns all equation symbols in the Container.
Returns
-------
list[Equation]
Examples
--------
>>> import gamspy as gp
>>> m = gp.Container()
>>> eq1 = gp.Equation(m, name="eq1")
>>> eq2 = gp.Equation(m, name="eq2")
>>> equation_objects = m.getEquations()
"""
equations = [
equation
for equation in self.listEquations()
if not equation.startswith(gp.Model._generate_prefix)
]
return self.getSymbols(equations)
[docs]
def importExtrinsicLibrary(
self, lib_path: str, functions: dict[str, str]
) -> ExtrinsicLibrary:
"""
Imports an extrinsic library to the GAMS environment.
Parameters
----------
lib_path : str
Path to the .so, .dylib or .dll file that contains the extrinsic library
functions : dict[str, str]
Names of the functions as a dictionary. Key is the desired function name in GAMSPy
and value is the function name in the extrinsic library.
Returns
-------
ExtrinsicLibrary
Raises
------
FileNotFoundError
In case the extrinsic library does not exist in the given path.
Examples
--------
>>> import gamspy as gp
>>> m = gp.Container()
>>> # Assuming 'trilib.so' is a valid library path
>>> # lib = m.importExtrinsicLibrary("trilib.so", {"my_cos": "Cosine", "my_sin": "Sine"})
>>> # c = lib.my_cos(0)
"""
if not os.path.exists(lib_path):
raise FileNotFoundError(f"`{lib_path}` is not a valid path.")
external_lib = ExtrinsicLibrary(self, lib_path, functions)
self._add_statement(external_lib)
return external_lib
[docs]
def gamsJobName(self) -> str | None:
"""
Returns the name of the latest GAMS job that was executed
Returns
-------
str | None
Examples
--------
>>> import gamspy as gp
>>> m = gp.Container()
>>> i = gp.Set(m, "i", records=["seattle", "san-diego"], description="canning plants")
>>> gams_file_name = f"{m.gamsJobName()}.gms"
"""
return self._job
[docs]
def gdxOutputPath(self) -> str:
"""
Path to the output GDX file
Returns
-------
str
Examples
--------
>>> import gamspy as gp
>>> m = gp.Container()
>>> i = gp.Set(m, name="i", records=["seattle", "san-diego"], description="canning plants")
>>> ii = gp.Set(m, name="ii", domain=i, description="seattle plant")
>>> ii['seattle'] = True
>>> gdx_path = m.gdxOutputPath()
"""
return self._gdx_out
