[MERGE] Merge branch 'release/1.20.0' into 'master'

Release/1.20.0

See merge request devel/gamspy!755

Author: mabdullahsoyturk

.pre-commit-config.yaml

@@ -19,7 +19,7 @@ repos:
     -   id: detect-secrets
         args: [ --baseline, .secrets.baseline, --exclude-files, ^docs/user/notebooks/]
 -   repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.15.0
+    rev: v0.15.1
     hooks:
     # Run the linter.
     -   id: ruff-check

.secrets.baseline

@@ -135,9 +135,9 @@
         "filename": "tests/integration/test_engine.py",
         "hashed_secret": "ffa6706ff2127a749973072756f83c532e43ed02",
         "is_verified": false,
-        "line_number": 211
+        "line_number": 208
       }
     ]
   },
-  "generated_at": "2026-01-27T21:53:18Z"
+  "generated_at": "2026-02-05T15:17:49Z"
 }

CHANGELOG.rst

@@ -1,3 +1,28 @@
+GAMSPy 1.20.0 (2026-02-18)
+==========================
+
+Improvements in existing functionality
+--------------------------------------
+- #765: Return FormulationResult instance for Neural Network formulations (pooling, convolution, and linear layers).
+- #772: Allow specifying gdx and python files as an option in 'gamspy mps2gms' command. Add '--compress' option to 'gamspy mps2gms'.
+
+Bug fixes
+---------
+- #777: Fix model attribute updates for frozen models.
+
+Improved documentation
+----------------------
+- #764: Sync tabs in embed neural networks docs.
+- #771: Add a FAQ entry about running model instances in MPS or LP format.
+
+Dependencies
+------------
+- #774: Upgrade gamspy_base and gamsapi dependency ranges.
+
+Miscellaneous internal changes
+------------------------------
+- #768: Use pytest's tmp_path for tests instead of creating temp directories manually.
+
 GAMSPy 1.19.3 (2026-02-06)
 ==========================
 

docs/_static/switcher.json

@@ -1 +1 @@
-[{"name": "latest", "version": "latest", "url": "https://gamspy.readthedocs.io/en/latest/"}, {"name": "1.19.3 (stable)", "version": "v1.19.3", "url": "https://gamspy.readthedocs.io/en/v1.19.3/"}, {"name": "1.19.2", "version": "v1.19.2", "url": "https://gamspy.readthedocs.io/en/v1.19.2/"}, {"name": "1.19.1", "version": "v1.19.1", "url": "https://gamspy.readthedocs.io/en/v1.19.1/"}, {"name": "1.19.0", "version": "v1.19.0", "url": "https://gamspy.readthedocs.io/en/v1.19.0/"}, {"name": "1.18.4", "version": "v1.18.4", "url": "https://gamspy.readthedocs.io/en/v1.18.4/"}, {"name": "1.18.3", "version": "v1.18.3", "url": "https://gamspy.readthedocs.io/en/v1.18.3/"}, {"name": "1.18.2", "version": "v1.18.2", "url": "https://gamspy.readthedocs.io/en/v1.18.2/"}, {"name": "1.18.1", "version": "v1.18.1", "url": "https://gamspy.readthedocs.io/en/v1.18.1/"}, {"name": "1.18.0", "version": "v1.18.0", "url": "https://gamspy.readthedocs.io/en/v1.18.0/"}, {"name": "1.17.2", "version": "v1.17.2", "url": "https://gamspy.readthedocs.io/en/v1.17.2/"}, {"name": "1.17.1", "version": "v1.17.1", "url": "https://gamspy.readthedocs.io/en/v1.17.1/"}, {"name": "1.17.0", "version": "v1.17.0", "url": "https://gamspy.readthedocs.io/en/v1.17.0/"}, {"name": "1.16.0", "version": "v1.16.0", "url": "https://gamspy.readthedocs.io/en/v1.16.0/"}, {"name": "1.15.1", "version": "v1.15.1", "url": "https://gamspy.readthedocs.io/en/v1.15.1/"}, {"name": "1.15.0", "version": "v1.15.0", "url": "https://gamspy.readthedocs.io/en/v1.15.0/"}, {"name": "1.14.0", "version": "v1.14.0", "url": "https://gamspy.readthedocs.io/en/v1.14.0/"}, {"name": "1.13.0", "version": "v1.13.0", "url": "https://gamspy.readthedocs.io/en/v1.13.0/"}, {"name": "1.12.1", "version": "v1.12.1", "url": "https://gamspy.readthedocs.io/en/v1.12.1/"}, {"name": "1.12.0", "version": "v1.12.0", "url": "https://gamspy.readthedocs.io/en/v1.12.0/"}, {"name": "1.11.1", "version": "v1.11.1", "url": "https://gamspy.readthedocs.io/en/v1.11.1/"}, {"name": "1.11.0", "version": "v1.11.0", "url": "https://gamspy.readthedocs.io/en/v1.11.0/"}, {"name": "1.10.0", "version": "v1.10.0", "url": "https://gamspy.readthedocs.io/en/v1.10.0/"}, {"name": "1.9.0", "version": "v1.9.0", "url": "https://gamspy.readthedocs.io/en/v1.9.0/"}, {"name": "1.8.0", "version": "v1.8.0", "url": "https://gamspy.readthedocs.io/en/v1.8.0/"}, {"name": "1.7.0", "version": "v1.7.0", "url": "https://gamspy.readthedocs.io/en/v1.7.0/"}, {"name": "1.6.0", "version": "v1.6.0", "url": "https://gamspy.readthedocs.io/en/v1.6.0/"}, {"name": "1.5.1", "version": "v1.5.1", "url": "https://gamspy.readthedocs.io/en/v1.5.1/"}, {"name": "1.5.0", "version": "v1.5.0", "url": "https://gamspy.readthedocs.io/en/v1.5.0/"}, {"name": "1.4.0", "version": "v1.4.0", "url": "https://gamspy.readthedocs.io/en/v1.4.0/"}, {"name": "1.3.1", "version": "v1.3.1", "url": "https://gamspy.readthedocs.io/en/v1.3.1/"}, {"name": "1.3.0", "version": "v1.3.0", "url": "https://gamspy.readthedocs.io/en/v1.3.0/"}, {"name": "1.2.0", "version": "v1.2.0", "url": "https://gamspy.readthedocs.io/en/v1.2.0/"}, {"name": "1.1.0", "version": "v1.1.0", "url": "https://gamspy.readthedocs.io/en/v1.1.0/"}, {"name": "1.0.4", "version": "v1.0.4", "url": "https://gamspy.readthedocs.io/en/v1.0.4/"}, {"name": "1.0.3", "version": "v1.0.3", "url": "https://gamspy.readthedocs.io/en/v1.0.3/"}, {"name": "1.0.2", "version": "v1.0.2", "url": "https://gamspy.readthedocs.io/en/v1.0.2/"}, {"name": "1.0.1", "version": "v1.0.1", "url": "https://gamspy.readthedocs.io/en/v1.0.1/"}, {"name": "1.0.0", "version": "v1.0.0", "url": "https://gamspy.readthedocs.io/en/v1.0.0/"}, {"name": "0.14.7", "version": "v0.14.7", "url": "https://gamspy.readthedocs.io/en/v0.14.7/"}, {"name": "0.14.6", "version": "v0.14.6", "url": "https://gamspy.readthedocs.io/en/v0.14.6/"}, {"name": "0.14.5", "version": "v0.14.5", "url": "https://gamspy.readthedocs.io/en/v0.14.5/"}, {"name": "0.14.4", "version": "v0.14.4", "url": "https://gamspy.readthedocs.io/en/v0.14.4/"}, {"name": "0.14.3", "version": "v0.14.3", "url": "https://gamspy.readthedocs.io/en/v0.14.3/"}, {"name": "0.14.2", "version": "v0.14.2", "url": "https://gamspy.readthedocs.io/en/v0.14.2/"}, {"name": "0.14.1", "version": "v0.14.1", "url": "https://gamspy.readthedocs.io/en/v0.14.1/"}, {"name": "0.14.0", "version": "v0.14.0", "url": "https://gamspy.readthedocs.io/en/v0.14.0/"}]
+[{"name": "latest", "version": "latest", "url": "https://gamspy.readthedocs.io/en/latest/"}, {"name": "1.20.0 (stable)", "version": "v1.20.0", "url": "https://gamspy.readthedocs.io/en/v1.20.0/"}, {"name": "1.19.3", "version": "v1.19.3", "url": "https://gamspy.readthedocs.io/en/v1.19.3/"}, {"name": "1.19.2", "version": "v1.19.2", "url": "https://gamspy.readthedocs.io/en/v1.19.2/"}, {"name": "1.19.1", "version": "v1.19.1", "url": "https://gamspy.readthedocs.io/en/v1.19.1/"}, {"name": "1.19.0", "version": "v1.19.0", "url": "https://gamspy.readthedocs.io/en/v1.19.0/"}, {"name": "1.18.4", "version": "v1.18.4", "url": "https://gamspy.readthedocs.io/en/v1.18.4/"}, {"name": "1.18.3", "version": "v1.18.3", "url": "https://gamspy.readthedocs.io/en/v1.18.3/"}, {"name": "1.18.2", "version": "v1.18.2", "url": "https://gamspy.readthedocs.io/en/v1.18.2/"}, {"name": "1.18.1", "version": "v1.18.1", "url": "https://gamspy.readthedocs.io/en/v1.18.1/"}, {"name": "1.18.0", "version": "v1.18.0", "url": "https://gamspy.readthedocs.io/en/v1.18.0/"}, {"name": "1.17.2", "version": "v1.17.2", "url": "https://gamspy.readthedocs.io/en/v1.17.2/"}, {"name": "1.17.1", "version": "v1.17.1", "url": "https://gamspy.readthedocs.io/en/v1.17.1/"}, {"name": "1.17.0", "version": "v1.17.0", "url": "https://gamspy.readthedocs.io/en/v1.17.0/"}, {"name": "1.16.0", "version": "v1.16.0", "url": "https://gamspy.readthedocs.io/en/v1.16.0/"}, {"name": "1.15.1", "version": "v1.15.1", "url": "https://gamspy.readthedocs.io/en/v1.15.1/"}, {"name": "1.15.0", "version": "v1.15.0", "url": "https://gamspy.readthedocs.io/en/v1.15.0/"}, {"name": "1.14.0", "version": "v1.14.0", "url": "https://gamspy.readthedocs.io/en/v1.14.0/"}, {"name": "1.13.0", "version": "v1.13.0", "url": "https://gamspy.readthedocs.io/en/v1.13.0/"}, {"name": "1.12.1", "version": "v1.12.1", "url": "https://gamspy.readthedocs.io/en/v1.12.1/"}, {"name": "1.12.0", "version": "v1.12.0", "url": "https://gamspy.readthedocs.io/en/v1.12.0/"}, {"name": "1.11.1", "version": "v1.11.1", "url": "https://gamspy.readthedocs.io/en/v1.11.1/"}, {"name": "1.11.0", "version": "v1.11.0", "url": "https://gamspy.readthedocs.io/en/v1.11.0/"}, {"name": "1.10.0", "version": "v1.10.0", "url": "https://gamspy.readthedocs.io/en/v1.10.0/"}, {"name": "1.9.0", "version": "v1.9.0", "url": "https://gamspy.readthedocs.io/en/v1.9.0/"}, {"name": "1.8.0", "version": "v1.8.0", "url": "https://gamspy.readthedocs.io/en/v1.8.0/"}, {"name": "1.7.0", "version": "v1.7.0", "url": "https://gamspy.readthedocs.io/en/v1.7.0/"}, {"name": "1.6.0", "version": "v1.6.0", "url": "https://gamspy.readthedocs.io/en/v1.6.0/"}, {"name": "1.5.1", "version": "v1.5.1", "url": "https://gamspy.readthedocs.io/en/v1.5.1/"}, {"name": "1.5.0", "version": "v1.5.0", "url": "https://gamspy.readthedocs.io/en/v1.5.0/"}, {"name": "1.4.0", "version": "v1.4.0", "url": "https://gamspy.readthedocs.io/en/v1.4.0/"}, {"name": "1.3.1", "version": "v1.3.1", "url": "https://gamspy.readthedocs.io/en/v1.3.1/"}, {"name": "1.3.0", "version": "v1.3.0", "url": "https://gamspy.readthedocs.io/en/v1.3.0/"}, {"name": "1.2.0", "version": "v1.2.0", "url": "https://gamspy.readthedocs.io/en/v1.2.0/"}, {"name": "1.1.0", "version": "v1.1.0", "url": "https://gamspy.readthedocs.io/en/v1.1.0/"}, {"name": "1.0.4", "version": "v1.0.4", "url": "https://gamspy.readthedocs.io/en/v1.0.4/"}, {"name": "1.0.3", "version": "v1.0.3", "url": "https://gamspy.readthedocs.io/en/v1.0.3/"}, {"name": "1.0.2", "version": "v1.0.2", "url": "https://gamspy.readthedocs.io/en/v1.0.2/"}, {"name": "1.0.1", "version": "v1.0.1", "url": "https://gamspy.readthedocs.io/en/v1.0.1/"}, {"name": "1.0.0", "version": "v1.0.0", "url": "https://gamspy.readthedocs.io/en/v1.0.0/"}, {"name": "0.14.7", "version": "v0.14.7", "url": "https://gamspy.readthedocs.io/en/v0.14.7/"}, {"name": "0.14.6", "version": "v0.14.6", "url": "https://gamspy.readthedocs.io/en/v0.14.6/"}, {"name": "0.14.5", "version": "v0.14.5", "url": "https://gamspy.readthedocs.io/en/v0.14.5/"}, {"name": "0.14.4", "version": "v0.14.4", "url": "https://gamspy.readthedocs.io/en/v0.14.4/"}, {"name": "0.14.3", "version": "v0.14.3", "url": "https://gamspy.readthedocs.io/en/v0.14.3/"}, {"name": "0.14.2", "version": "v0.14.2", "url": "https://gamspy.readthedocs.io/en/v0.14.2/"}, {"name": "0.14.1", "version": "v0.14.1", "url": "https://gamspy.readthedocs.io/en/v0.14.1/"}, {"name": "0.14.0", "version": "v0.14.0", "url": "https://gamspy.readthedocs.io/en/v0.14.0/"}]

docs/cli/mps2gms.rst

@@ -11,7 +11,7 @@ Usage
 
 ::
 
-  gamspy mps2gms <input_file> [gdx_file] [gms_file] [OPTIONS]
+  gamspy mps2gms <input_file> [OPTIONS]
 
 .. note::
   If no output files are specified, the command automatically generates ``<input>.py`` and ``<input>.gdx``.
@@ -24,6 +24,14 @@ Usage
      - Short
      - Default
      - Description
+   * - --gdx
+     - 
+     - <input_file>.gdx
+     - Name of GDX output file.
+   * - --gms
+     - 
+     - None
+     - Name of GAMS program output file.
    * - --py
      - 
      - None
@@ -48,6 +56,10 @@ Usage
      - 
      - 2
      - Shift block numbers by this integer value for stage attributes.
+   * - --compress
+     - 
+     - None
+     - Whether to compress output gdx.
    * - --convertsense
      - 
      - 0

docs/release/index.rst

@@ -7,6 +7,7 @@ Release Notes
 .. toctree::
    :maxdepth: 1
 
+   release_1.20.0
    release_1.19.3
    release_1.19.2
    release_1.19.1

docs/release/release_1.20.0.rst

@@ -0,0 +1,25 @@
+GAMSPy 1.20.0 (2026-02-18)
+==========================
+
+Improvements in existing functionality
+--------------------------------------
+- #765: Return FormulationResult instance for Neural Network formulations (pooling, convolution, and linear layers).
+- #772: Allow specifying gdx and python files as an option in 'gamspy mps2gms' command. Add '--compress' option to 'gamspy mps2gms'.
+
+Bug fixes
+---------
+- #777: Fix model attribute updates for frozen models.
+
+Improved documentation
+----------------------
+- #764: Sync tabs in embed neural networks docs.
+- #771: Add a FAQ entry about running model instances in MPS or LP format.
+
+Dependencies
+------------
+- #774: Upgrade gamspy_base and gamsapi dependency ranges.
+
+Miscellaneous internal changes
+------------------------------
+- #768: Use pytest's tmp_path for tests instead of creating temp directories manually.
+

docs/user/faq.rst

@@ -329,3 +329,46 @@ If you have a network license, you should declare ``CURL_PROXY`` environment var
 communication via proxy with the license server: ::
 
     CURL_PROXY=<proxy_server> python <your_script>.py 
+
+How can I solve model instances in MPS or LP format with GAMSPy?
+----------------------------------------------------------------
+
+GAMSPy cannot directly read MPS or LP files. The CLI command `mps2gms <https://gamspy.readthedocs.io/en/latest/cli/mps2gms.html>`_ 
+can be used to convert a model instance in MPS or LP format into a GAMSPy script: ::
+
+    gamspy mps2gms model.mps
+
+This creates a GDX file model.gdx with all the instance data and a generic GAMSPy script to solve the 
+corresponding model instance. Once the GAMSPy script is generated, you can run: ::
+
+    python model.py
+
+to solve your model instance. You can easily customize the script model.py to select a solver or set solver options. 
+For example, the following changes to the solve method in the last line of the script model.py set the solver to HiGHS, 
+select the HiPO interior point method, set threads to 6, and instruct to do no crossover: ::
+
+    mps_model.solve(
+        solver="highs",
+        solver_options={
+            "solver": "hipo",
+            "threads": 6,
+            "run_crossover": "off",
+        },
+        output=sys.stdout,
+    )
+
+The `mps2gms <https://gamspy.readthedocs.io/en/latest/cli/mps2gms.html>`_ CLI tool has a couple of options 
+that can come in handy, e.g. with option --convertsense MIN you can turn the problem into a minimization 
+problem independent of the original objective sense. Moreover, mps2gms also converts compressed (gzip) 
+MPS and LP files. The GDX representation of the data can also be stored in compressed format, by setting 
+the environment variable GDXCOMPRESS to 1, e.g. (on Linux): ::
+
+    GDXCOMPRESS=1 gamspy mps2gms model.mps.gz
+
+The compressed GDX files are usually half the size of the compressed MPS files. Moreover, with the convert 
+method one can again create MPS files: ::
+
+    mps_model.convert('.', file_format=gp.FileFormat.CPLEXMPS)
+
+This creates cplex.mps in the current directory.
+