Skip to content

Commit 94680c3

Browse files
jurgen-lentzjurgen-lentz
committed
fixes
1 parent 177d1c2 commit 94680c3

File tree

2 files changed

+12
-103
lines changed

2 files changed

+12
-103
lines changed

‎INSTALL.md

Lines changed: 6 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -34,111 +34,20 @@ python3.9 -m venv venv
3434
source venv/bin/activate
3535
```
3636

37-
## Installing SCIPOptSuite from the binary distribution
38-
39-
The SCIPOptSuite can either be installed from the binary distribution or it can be build and installed manually from source. If you want to compile the SCIPOptSuite from source, please skip to the next section.
40-
41-
To install a binary distribution of the SCIPOptSuite, navigate to the [download page](https://scipopt.org/index.php#download) and select at least version 8.0.0 and your operating system. After the installation, please check that you can run `scip` and `gcg` from the command line.
42-
43-
Next, skip to the instructions to install PySCIPOpt.
44-
45-
## Compiling SCIPOptSuite from source
46-
47-
To install the SCIPOptSuite from source, you need to [install SCIP and GCG using CMake](https://scipopt.org/doc/html/md_INSTALL.php#CMAKE). The Makefile system is not compatible with PyGCGOpt and PySCIPOpt!
48-
49-
As an example, from the root directory of the source distribution of the SCIPOptSuite, you can run the following commands to build and install locally:
50-
```
51-
mkdir build && cd build
52-
cmake .. -DCMAKE_BUILD_TYPE=Debug -DSHARED=on -DCMAKE_INSTALL_PREFIX=./install -DGCG_DEV_BUILD=ON -DZIMPL=OFF -DIPOPT=OFF -DPAPILO=OFF
53-
make -j4 && make install
54-
```
55-
56-
If SCIP and GCG are not installed in the global path, you need to specify the install location using the environment variable `SCIPOPTDIR` before you can install PySCIPOpt and PyGCGOpt:
57-
58-
- On Linux and macOS:\
59-
`export SCIPOPTDIR=<path_to_install_dir>`
60-
- On Windows:\
61-
`set SCIPOPTDIR=<path_to_install_dir>` (**cmd**, **Cmder**, **WSL**)\
62-
`$Env:SCIPOPTDIR = "<path_to_install_dir>"` (**powershell**)
63-
64-
`SCIPOPTDIR` needs to have a subdirectory `lib` that contains the
65-
library, e.g. `libscip.so` and `libgcg.so` (for Linux) and a subdirectory `include` that
66-
contains the corresponding header files:
67-
68-
SCIPOPTDIR
69-
> lib
70-
> libscip.so ...
71-
> libgcg.so ...
72-
> include
73-
> scip
74-
> gcg
75-
> lpi
76-
> nlpi
77-
> ...
78-
79-
If GCG is installed in a different location than SCIP (this is *not* the default), you can specify the GCG install directory with the `GCGOPTDIR` environment variable.
80-
81-
To make the shared libraries available at runtime for PySCIPOpt and PyGCGOpt, you need to add them to the corresponding environment variables:
82-
- On Linux:
83-
`export LD_LIBRARY_PATH=<path_to_install_dir>/lib`
84-
- On macOS:
85-
`export DYLD_FALLBACK_LIBRARY_PATH=<path_to_install_dir>/lib`
86-
- On Windows:
87-
`set PATH=%PATH%;<path_to_install_dir>\bin`
88-
89-
90-
## Installing PySCIPOpt from PyPI
91-
92-
To install PySCIPOpt using pip, run the following:
93-
```
94-
pip install PySCIPOpt>=4.0.0
95-
```
96-
97-
98-
## Installing PySCIPOpt from source
99-
100-
For detailed instructions, please read the [installation instructions of PySCIPOpt](https://github.com/scipopt/PySCIPOpt/blob/master/INSTALL.md#building-everything-from-source).
101-
102-
In short, you can install PySCIPOpt from source with `pip`. For that, run the following command:
103-
```
104-
pip install <path/to/PySCIPOpt>
105-
```
106-
10737
## Installing PyGCGOpt from PyPI
10838

109-
Simply run the folloing to install PyGCGOpt with `pip`:
39+
Simply run the following to install PyGCGOpt (and its requirement PySCIPOpt) with `pip`:
11040
```
41+
pip install PySCIPOpt
11142
pip install PyGCGOpt
11243
```
11344

114-
## Install PyGCGOpt from source
115-
-------------------------------
116-
117-
First, install the requirements for building PyGCGOpt:
118-
```
119-
pip install -r requirements.txt
120-
```
121-
122-
Furthermore, you need to have the Python development files installed on your system (error message "Python.h not found"):
123-
```
124-
sudo apt-get install python3-dev # for Python 3, on Linux
125-
```
126-
127-
Then, compile and install PyGCGOpt:
128-
```
129-
pip install .
130-
```
131-
132-
In case the compiler cannot find SCIP or GCG header files, please make sure that you installed the SCIPOptSuite globally or that you set the `SCIPOPTDIR` environment variable (see above).
133-
134-
### Building with debug information
135-
136-
To use debug information in PyGCGOpt you need to build it like this:
45+
The following table summarizes which versions of PyGCGOpt and PySCIPOpt are compatible:
13746

138-
python -m pip install --install-option="--debug" .
47+
| PySCIPOpt | PyGCGOpt |
48+
|----|----|
49+
| 5.2.1 | 0.4.0 |
13950

140-
Be aware that you will need the **debug library** of the SCIPOptSuite for this to work
141-
(`cmake .. -DCMAKE_BUILD_TYPE=Debug`).
14251

14352
## Testing new installation
14453

‎docs/requirements.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
Sphinx
2-
sphinx_copybutton
3-
furo
4-
myst-parser
5-
nbsphinx
6-
jupyter
1+
Sphinx==4.3.1
2+
sphinx_copybutton==0.4.0
3+
furo==2021.11.23
4+
myst-parser==0.15.2
5+
nbsphinx==0.8.7
6+
jupyter==1.0.0

0 commit comments

Comments
 (0)