https://github.com/cog-imperial/suspect
Special Structure Detection for Pyomo
https://github.com/cog-imperial/suspect
convexity mathematical-programming mixed-integer-optimization nonlinear-optimization pyomo
Last synced: 22 days ago
JSON representation
Special Structure Detection for Pyomo
- Host: GitHub
- URL: https://github.com/cog-imperial/suspect
- Owner: cog-imperial
- License: apache-2.0
- Created: 2018-03-28T09:42:37.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2022-07-14T10:31:11.000Z (almost 4 years ago)
- Last Synced: 2026-01-05T23:35:56.534Z (4 months ago)
- Topics: convexity, mathematical-programming, mixed-integer-optimization, nonlinear-optimization, pyomo
- Language: Python
- Homepage: https://cog-imperial.github.io/suspect/
- Size: 1.21 MB
- Stars: 26
- Watchers: 6
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- License: LICENSE
Awesome Lists containing this project
README
Special Structure Detection for Pyomo
=====================================
|DOI|_ |GHA|_ |codecov|_
.. |DOI| image:: https://zenodo.org/badge/127118649.svg
.. _DOI: https://zenodo.org/badge/latestdoi/127118649
.. |GHA| image:: https://github.com/cog-imperial/suspect/actions/workflows/main.yml/badge.svg
.. _GHA: https://github.com/cog-imperial/suspect/actions/workflows/main.yml
.. |codecov| image:: https://codecov.io/gh/cog-imperial/suspect/branch/master/graph/badge.svg
.. _codecov: https://codecov.io/gh/cog-imperial/suspect
This library implements methods to:
* Detect convex and concave expressions
* Detect increasing and decreasing expressions
* Detect linear, quadratic and polynomial expressions
* Tighten expression bounds
Please reference this software as
.. code-block:: latex
@Article{Suspect2019,
author={Ceccon, Francesco and Siirola, John D. and Misener, Ruth},
title={{SUSPECT}: {MINLP} special structure detector for Pyomo},
journal={Optimization Letters},
year={2019},
month={Feb},
issn="1862-4480",
doi="10.1007/s11590-019-01396-y",
url="https://doi.org/10.1007/s11590-019-01396-y"
}
Documentation
-------------
Documentation is available at https://cog-imperial.github.io/suspect/
Installation
------------
SUSPECT requires Python 3.5 or later. We recommend installing SUSPECT in
a virtual environment
To create the virtual environment run::
$ python3 -m venv myenv
$ source myenv/bin/activate
Then you are ready to clone and install SUSPECT::
$ git clone https://github.com/cog-imperial/suspect.git
$ cd suspect
$ pip install -r requirements.txt
$ pip install .
Command Line Usage
------------------
The package contains an utility to display structure information about
a single problem.
You can run the utility as::
model_summary.py -p /path/to/problem.osil
or, if you want to check variables bounds include the solution::
model_summary.py -p /path/to/problem.osil -s /path/to/problem.sol
The repository also includes a `Dockerfile` to simplify running the utility in
batch mode in a cloud environment. Refer to the `batch` folder for more information.
Library Usage
-------------
.. code-block:: python
from suspect import detect_special_structure, create_connected_model
import pyomo.environ as aml
model = aml.ConcreteModel()
model.x = aml.Var()
model.y = aml.Var()
model.obj = aml.Objective(expr=(model.y - model.x)**3)
model.c1 = aml.Constraint(expr=model.y - model.x >= 0)
connected, _ = create_connected_model(model)
info = detect_special_structure(connected)
# try info.variables, info.objectives, and info.constraints
print(info.objectives['obj'])
License
-------
Copyright 2020 Francesco Ceccon
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at::
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Acknowledgements
----------------
This work was funded by an Engineering & Physical Sciences Research Council Research Fellowship to RM [Grant Number EP/P016871/1].