Skip to content

Update INSTALL.md #974

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 19, 2025
Merged

Update INSTALL.md #974

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
95cfd9a
Some notes from Dominik
Joao-Dionisio Apr 16, 2025
3d3d402
Also add note to documentation
Joao-Dionisio Apr 17, 2025
158a237
Merge branch 'master' into dominik-note
Joao-Dionisio Apr 19, 2025
ead5320
move things around
Joao-Dionisio Apr 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions INSTALL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ Suite](https://www.scipopt.org/). Please, make sure that your SCIP installation

**Note that the latest PySCIPOpt version is usually only compatible with the latest major release of the SCIP Optimization Suite. See the table on the README.md page for details.**

If you install SCIP yourself and are not using the installer packages, you need to [install the
SCIP Optimization Suite using CMake](https://www.scipopt.org/doc/html/md_INSTALL.php#CMAKE).
The Makefile system is not compatible with PySCIPOpt!

If installing SCIP from source or using PyPI with a python and operating system that is not mentioned above, and SCIP is not installed in the global path,
you need to specify the install location using the environment variable
`SCIPOPTDIR`:
Expand All @@ -41,9 +45,8 @@ contains the corresponding header files:
> nlpi
> ...

If you install SCIP yourself and are not using the installer packages, you need to [install the
SCIP Optimization Suite using CMake](https://www.scipopt.org/doc/html/md_INSTALL.php#CMAKE).
The Makefile system is not compatible with PySCIPOpt!
Please note that some Mac configurations require adding the library installation path to `DYLD_LIBRARY_PATH` when using a locally installed version of SCIP.


When building SCIP from source using Windows it is highly recommended to use the [Anaconda Python
Platform](https://www.anaconda.com/).
Expand All @@ -55,7 +58,7 @@ Installation from PyPI

Please note that if your Python version and OS version are in the combinations at the start of this INSTALL file then
pip now automatically installs a pre-built version of SCIP. For these combinations, to use your own installation of SCIP,
plese see the section on building from source. For unavailable combinations this pip command will automatically
please see the section on building from source. For unavailable combinations this pip command will automatically
search your global installs or custom set paths as above.

On Windows for combinations not listed at the start of this file, you may need to ensure that the `scip` library can be found
Expand Down
2 changes: 2 additions & 0 deletions docs/install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ To install PySCIPOpt simply run the command:
This means that SCIP must be installed yourself. If it is not installed globally,
then the ``SCIPOPTDIR`` environment flag must be set, see :doc:`this page </build>` for more details.

.. note:: Some Mac configurations require adding the library installation path to `DYLD_LIBRARY_PATH` when
using a locally installed version of SCIP.

Conda
=====
Expand Down
Loading