Skip to content

Commit

Permalink
v0.4.0 v2
Browse files Browse the repository at this point in the history
  • Loading branch information
jurgen-lentz committed Dec 8, 2024
1 parent 22f2baf commit 0e12361
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 24 deletions.
23 changes: 0 additions & 23 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,29 +11,6 @@ Conda will install `GCG`, `SCIP` and `PySCIPOpt` automatically, hence everything
conda install --channel conda-forge pygcgopt
```

## Requirements

PyGCGOpt requires a working installation of the [SCIPOptSuite](https://scipopt.org) and the [GCG Solver](https://gcg.or.rwth-aachen.de/) which is usually included in the release. In addition, the Python interface for SCIP, [PySCIPOpt](https://github.com/scipopt/PySCIPOpt), has to be installed. Currently, GCG only runs on Linux and macOS, therefore you can use PyGCGOpt only on these operating systems.

Note that the latest PyGCGOpt version is usually only compatible with the latest major release of the SCIP Optimization Suite. PyGCGOpt requires at least SCIP 8.0 and GCG 3.5. The following table summarizes which versions of PyGCGOpt, GCG, PySCIPOpt, and SCIP are compatible:

|SCIP| PySCIPOpt | GCG | PyGCGOpt
|----|----|----|----|
9.0 | 5.0.0 | 3.6.0 | 0.4.0 |
8.1 | 4.4 | 3.5.5 | 0.3.0 |
8.0 | 4.0 | 3.5.0 | 0.1.0 |
7.0 | 3.x | - | - |
6.0 | 2.x | - | - |
5.0 | 1.4, 1.3 | - | - |
4.0 | 1.2, 1.1 | - | - |
3.2 | 1.0 | - | - |

We recommend installing PyGCGOpt and its Python dependencies in a [Python virtual environment](https://docs.python.org/3/tutorial/venv.html). In short, you can create a virtual environment and activate it with the following commands on Linux, macOS and Windows:
```
python3.9 -m venv venv
source venv/bin/activate
```

## Installing PyGCGOpt from PyPI

Simply run the following to install PyGCGOpt (and its requirement PySCIPOpt) with `pip`:
Expand Down
2 changes: 1 addition & 1 deletion src/pygcgopt/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
__version__ = '0.4.0b0'
__version__ = '0.4.0'

# required for Python 3.8 on Windows
import os
Expand Down

0 comments on commit 0e12361

Please sign in to comment.