Merge branch 'scipopt:master' into add-set-logfile

Author: steffanschlein

.gitignore

@@ -126,3 +126,4 @@ model.lp
 
 # VSCode
 .vscode/
+.devcontainer/

.travis.yml

@@ -6,10 +6,10 @@ language: python
 
 matrix:
   include:
-    - python: 3.5
     - python: 3.6
     - python: 3.7
     - python: 3.8
+    - python: 3.9
       env: TRAVIS_BUILD_DOCS=$TRAVIS_TAG
       addons:
         apt:

CHANGELOG.md

@@ -2,7 +2,29 @@
 
 ## Unreleased
 ### Added
-- add more SCIP functions: `getNSols`
+### Fixed
+### Changed
+### Removed
+
+## 3.1.4 - 2021-04-25
+### Fixed
+- check for correct stage when querying solution values (raise warning otherwise)
+
+## 3.1.3 - 2021-04-23
+### Fixed
+- check for NULL pointers when creating Solution objects (will return None): [#494](https://github.com/scipopt/PySCIPOpt/pull/494)
+
+## 3.1.2 - 2021-04-07
+### Added
+- add `Model.getNReaders` that returns the number of available readers
+
+## 3.1.1 - 2021-03-10
+### Added
+- add evaluation of `Expr` in `Solution`.
+
+## 3.1.0 - 2020-12-17
+### Added
+- add more SCIP functions: `getNSols`, `createPartialSol`
 
 ### Fixed
 - consistent handling of filenames for reading/writing

INSTALL.md

@@ -9,8 +9,8 @@ The following table summarizes which version of PySCIPOpt is required for a give
 
 |SCIP| PySCIPOpt |
 |----|----|
-7.0 | 3.0
-6.0 | 2.2, 2.1, 2.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
@@ -48,7 +48,7 @@ Platform](https://www.anaconda.com/).
 Installation from PyPI
 ======================
 
-`pip install pyscipopt`
+    python -m pip install pyscipopt
 
 On Windows you may need to ensure that the `scip` library can be found
 at runtime by adjusting your `PATH` environment variable:
@@ -61,24 +61,39 @@ therefore not necessary.
 Building everything from source
 ===============================
 
-PySCIPOpt requires [Cython](http://cython.org/), at least version 0.21
-(`pip install cython`). Furthermore, you need to have the Python
+Recommended is to install in a virtual environment (e.g. `python3 -m venv <DIR_PATH>`).
+Please note that a globally installed version of PySCIPOpt on your machine might lead to problems.
+
+After setting up and activating your virtual environment (`source <DIR_PATH>/bin/activate`) make sure you have [Cython](http://cython.org/) installed, at least version 0.21
+
+    pip install cython
+
+Note you will also need the `wheel` package, which usually is already installed:
+
+    pip install wheel
+
+Furthermore, you need to have the Python
 development files installed on your system (error message "Python.h not
 found"):
 
     sudo apt-get install python-dev   # for Python 2, on Linux
     sudo apt-get install python3-dev  # for Python 3, on Linux
 
-After setting up `SCIPOPTDIR` as specified above, please run
+After setting up `SCIPOPTDIR` as specified above install pyscipopt
 
-    pip install [-e] .
+    export SCIPOPTDIR=/path/to/scip/install/dir
+    python -m pip install [-e] .
+
+For recompiling the source in the current directory `.` use
+
+    python -m pip install --compile .
 
 Building with debug information
 ===============================
 
 To use debug information in PySCIPOpt you need to build it like this:
 
-    pip install [-e] --install-option="--debug" .
+    python -m pip install [-e] --install-option="--debug" .
 
 Be aware that you will need the **debug library** of the SCIP
 Optimization Suite for this to work
@@ -88,7 +103,11 @@ Testing new installation
 ========================
 
 To test your brand-new installation of PySCIPOpt you need
-[pytest](https://pytest.org/) on your system. Here is the [installation
+[pytest](https://pytest.org/) on your system.
+
+    pip install pytest
+
+Here is the complete [installation
 procedure](https://docs.pytest.org/en/latest/getting-started.html).
 
 Tests can be run in the `PySCIPOpt` directory with: :

README.md

@@ -2,7 +2,7 @@ PySCIPOpt
 =========
 
 This project provides an interface from Python to the [SCIP Optimization
-Suite](http://scip.zib.de).
+Suite](https://www.scipopt.org/).
 
 [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/PySCIPOpt/Lobby)
 [![PySCIPOpt on PyPI](https://img.shields.io/pypi/v/pyscipopt.svg)](https://pypi.python.org/pypi/pyscipopt)
@@ -13,13 +13,25 @@ Suite](http://scip.zib.de).
 Documentation
 -------------
 
-Please consult the [online documentation](http://scipopt.github.io/PySCIPOpt/docs/html) or use the `help()` function directly in Python or `?` in IPython/Jupyter.
+Please consult the [online documentation](https://scipopt.github.io/PySCIPOpt/docs/html) or use the `help()` function directly in Python or `?` in IPython/Jupyter.
 
 See [CHANGELOG.md](CHANGELOG.md) for added, removed or fixed functionality.
 
 Installation
 ------------
 
+**Using Conda**
+
+[![Conda version](https://img.shields.io/conda/vn/conda-forge/pyscipopt?logo=conda-forge)](https://anaconda.org/conda-forge/pyscipopt)
+[![Conda platforms](https://img.shields.io/conda/pn/conda-forge/pyscipopt?logo=conda-forge)](https://anaconda.org/conda-forge/pyscipopt)
+
+Conda will install SCIP automatically, hence everything can be installed in a single command:
+```bash
+conda install --channel conda-forge pyscipopt
+```
+
+**Using PyPI and from Source**
+
 See [INSTALL.md](INSTALL.md) for instructions.
 Please note that the latest PySCIPOpt version is usually only compatible with the latest major release of the SCIP Optimization Suite.
 Information which version of PySCIPOpt is required for a given SCIP version can also be found in [INSTALL.md](INSTALL.md).

appveyor.yml

@@ -23,6 +23,11 @@ environment:
       PIP: C:\Python38-x64\Scripts\pip
       PYTEST: C:\Python38-x64\Scripts\pytest
       TWINE: C:\Python38-x64\Scripts\twine
+#     - APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2019
+#       PYTHON: C:\Python39-x64
+#       PIP: C:\Python39-x64\Scripts\pip
+#       PYTEST: C:\Python39-x64\Scripts\pytest
+#       TWINE: C:\Python39-x64\Scripts\twine
 
 
 install:

setup.py

@@ -41,7 +41,7 @@
     extra_compile_args.append('-UNDEBUG')
     sys.argv.remove("--debug")
 
-cythonize = True
+use_cython = True
 
 packagedir = os.path.join('src', 'pyscipopt')
 
@@ -55,12 +55,12 @@
     if not os.path.exists(os.path.join(packagedir, 'scip.c')):
         print('Cython is required')
         quit(1)
-    cythonize = False
+    use_cython = False
 
 if not os.path.exists(os.path.join(packagedir, 'scip.pyx')):
-    cythonize = False
+    use_cython = False
 
-ext = '.pyx' if cythonize else '.c'
+ext = '.pyx' if use_cython else '.c'
 
 extensions = [Extension('pyscipopt.scip', [os.path.join(packagedir, 'scip'+ext)],
                           include_dirs=[includedir],
@@ -70,33 +70,33 @@
                           extra_link_args=extra_link_args
                           )]
 
-if cythonize:
-    extensions = cythonize(extensions, compiler_directives = {'language_level': 3})
-#     extensions = cythonize(extensions, compiler_directives={'linetrace': True})
+if use_cython:
+    extensions = cythonize(extensions, compiler_directives={'language_level': 3})
 
 with open('README.md') as f:
     long_description = f.read()
 
 setup(
-    name = 'PySCIPOpt',
-    version = version,
-    description = 'Python interface and modeling environment for SCIP',
-    long_description = long_description,
+    name='PySCIPOpt',
+    version=version,
+    description='Python interface and modeling environment for SCIP',
+    long_description=long_description,
     long_description_content_type='text/markdown',
-    url = 'https://github.com/SCIP-Interfaces/PySCIPOpt',
-    author = 'Zuse Institute Berlin',
-    author_email = 'scip@zib.de',
-    license = 'MIT',
+    url='https://github.com/SCIP-Interfaces/PySCIPOpt',
+    author='Zuse Institute Berlin',
+    author_email='scip@zib.de',
+    license='MIT',
     classifiers=[
-    'Development Status :: 4 - Beta',
-    'Intended Audience :: Science/Research',
-    'Intended Audience :: Education',
-    'License :: OSI Approved :: MIT License',
-    'Programming Language :: Python :: 3',
-    'Programming Language :: Cython',
-    'Topic :: Scientific/Engineering :: Mathematics'],
-    ext_modules = extensions,
-    packages = ['pyscipopt'],
-    package_dir = {'pyscipopt': packagedir},
-    package_data = {'pyscipopt': ['scip.pyx', 'scip.pxd', '*.pxi']}
+        'Development Status :: 4 - Beta',
+        'Intended Audience :: Science/Research',
+        'Intended Audience :: Education',
+        'License :: OSI Approved :: MIT License',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Cython',
+        'Topic :: Scientific/Engineering :: Mathematics'],
+    ext_modules=extensions,
+    install_requires=['wheel'],
+    packages=['pyscipopt'],
+    package_dir={'pyscipopt': packagedir},
+    package_data={'pyscipopt': ['scip.pyx', 'scip.pxd', '*.pxi']}
 )

src/pyscipopt/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '3.0.4'
+__version__ = '3.1.4'
 
 # required for Python 3.8 on Windows
 import os

src/pyscipopt/conshdlr.pxi

@@ -259,8 +259,7 @@ cdef SCIP_RETCODE PyConsSepasol (SCIP* scip, SCIP_CONSHDLR* conshdlr, SCIP_CONS*
     cdef constraints = []
     for i in range(nconss):
         constraints.append(getPyCons(conss[i]))
-    solution = Solution()
-    solution.sol = sol
+    solution = Solution.create(scip, sol)
     result_dict = PyConshdlr.conssepasol(constraints, nusefulconss, solution)
     result[0] = result_dict.get("result", <SCIP_RESULT>result[0])
     return SCIP_OKAY
@@ -280,8 +279,7 @@ cdef SCIP_RETCODE PyConsEnforelax (SCIP* scip, SCIP_SOL* sol, SCIP_CONSHDLR* con
     cdef constraints = []
     for i in range(nconss):
         constraints.append(getPyCons(conss[i]))
-    solution = Solution()
-    solution.sol = sol
+    solution = Solution.create(scip, sol)
     result_dict = PyConshdlr.consenforelax(solution, constraints, nusefulconss, solinfeasible)
     result[0] = result_dict.get("result", <SCIP_RESULT>result[0])
     return SCIP_OKAY
@@ -302,8 +300,7 @@ cdef SCIP_RETCODE PyConsCheck (SCIP* scip, SCIP_CONSHDLR* conshdlr, SCIP_CONS**
     cdef constraints = []
     for i in range(nconss):
         constraints.append(getPyCons(conss[i]))
-    solution = Solution()
-    solution.sol = sol
+    solution = Solution.create(scip, sol)
     result_dict = PyConshdlr.conscheck(constraints, solution, checkintegrality, checklprows, printreason, completely)
     result[0] = result_dict.get("result", <SCIP_RESULT>result[0])
     return SCIP_OKAY

src/pyscipopt/expr.pxi

@@ -109,13 +109,7 @@ class Term:
     def __repr__(self):
         return 'Term(%s)' % ', '.join([str(v) for v in self.vartuple])
 
-    def _evaluate(self, point):
-        '''computes the value of the term in the given variable-value mapping.'''
-        prod = 1
-        for var in self.vartuple:
-            prod *= point[var]
-        return prod
-        
+
 CONST = Term()
 
 # helper function
@@ -289,10 +283,6 @@ cdef class Expr:
         else:
             return max(len(v) for v in self.terms)
 
-    def _evaluate(self, point):
-        '''computes the value of the expression in the given variable-value mapping.'''
-        return sum(term._evaluate(point)*coeff for term, coeff in self.terms.items() if coeff != 0)
-
 
 cdef class ExprCons:
     '''Constraints with a polynomial expressions and lower/upper bounds.'''