Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pyomo/pyomo

An object-oriented algebraic modeling language in Python for structured optimization problems.
https://github.com/pyomo/pyomo

linear-programming mathematical-programming modeling-language nonlinear-programming optimization python

Last synced: 14 days ago
JSON representation

An object-oriented algebraic modeling language in Python for structured optimization problems.

Awesome Lists containing this project

README 

        
[![Github Actions Status](https://github.com/Pyomo/pyomo/workflows/GitHub%20CI/badge.svg?event=push)](https://github.com/Pyomo/pyomo/actions?query=event%3Apush+workflow%3A%22GitHub+CI%22)

[![Jenkins Status](https://github.com/Pyomo/jenkins-status/blob/main/pyomo_main.svg)](https://pyomo-jenkins.sandia.gov/)

[![codecov](https://codecov.io/gh/Pyomo/pyomo/branch/main/graph/badge.svg)](https://codecov.io/gh/Pyomo/pyomo)

[![Documentation Status](https://readthedocs.org/projects/pyomo/badge/?version=latest)](http://pyomo.readthedocs.org/en/latest/)

[![URL Validation](https://img.shields.io/github/actions/workflow/status/Pyomo/pyomo/url_check.yml?branch=main&label=doc%20urls)](https://github.com/Pyomo/pyomo/actions/workflows/url_check.yml)

[![Build services](https://github.com/Pyomo/jenkins-status/blob/main/pyomo_services.svg)](https://pyomo-jenkins.sandia.gov/)

[![GitHub contributors](https://img.shields.io/github/contributors/pyomo/pyomo.svg)](https://github.com/pyomo/pyomo/graphs/contributors)

[![Merged PRs](https://img.shields.io/github/issues-pr-closed-raw/pyomo/pyomo.svg?label=merged+PRs)](https://github.com/pyomo/pyomo/pulls?q=is:pr+is:merged)



[![a COIN-OR project](https://www.coin-or.org/GitHub/coin-or-badge.png)](https://www.coin-or.org)



## Pyomo Overview



Pyomo is a Python-based open-source software package that supports a

diverse set of optimization capabilities for formulating and analyzing

optimization models. Pyomo can be used to define symbolic problems,

create concrete problem instances, and solve these instances with

standard solvers. Pyomo supports a wide range of problem types,

including:



 -  Linear programming

 -  Quadratic programming

 -  Nonlinear programming

 -  Mixed-integer linear programming

 -  Mixed-integer quadratic programming

 -  Mixed-integer nonlinear programming

 -  Mixed-integer stochastic programming

 -  Generalized disjunctive programming

 -  Differential algebraic equations

 -  Mathematical programming with equilibrium constraints

 -  Constraint programming



Pyomo supports analysis and scripting within a full-featured programming

language. Further, Pyomo has also proven an effective framework for

developing high-level optimization and analysis tools.  For example, the

[`mpi-sppy`](https://github.com/Pyomo/mpi-sppy) package provides generic

solvers for stochastic programming. `mpi-sppy` leverages the fact that

Pyomo's modeling objects are embedded within a full-featured high-level

programming language, which allows for transparent parallelization of

subproblems using Python parallel communication libraries.



* [Pyomo Home](http://www.pyomo.org)

* [About Pyomo](http://www.pyomo.org/about)

* [Download](http://www.pyomo.org/installation/)

* [Documentation](http://www.pyomo.org/documentation/)

* [Performance Plots](https://pyomo.github.io/performance/)



Pyomo was formerly released as the Coopr software library.



Pyomo is available under the BSD License - see the 

[`LICENSE.md`](https://github.com/Pyomo/pyomo/blob/main/LICENSE.md) file.



Pyomo is currently tested with the following Python implementations:



* CPython: 3.8, 3.9, 3.10, 3.11, 3.12

* PyPy: 3.9



_Testing and support policy_:



At the time of the first Pyomo release after the end-of-life of a minor Python

version, we will remove testing for that Python version.



### Installation



#### PyPI [![PyPI version](https://img.shields.io/pypi/v/pyomo.svg?maxAge=3600)](https://pypi.org/project/Pyomo/) [![PyPI downloads](https://img.shields.io/pypi/dm/pyomo.svg?maxAge=21600)](https://pypistats.org/packages/pyomo)



    pip install pyomo



#### Anaconda [![Anaconda version](https://anaconda.org/conda-forge/pyomo/badges/version.svg)](https://anaconda.org/conda-forge/pyomo) [![Anaconda downloads](https://anaconda.org/conda-forge/pyomo/badges/downloads.svg)](https://anaconda.org/conda-forge/pyomo)



    conda install -c conda-forge pyomo



### Tutorials and Examples



* [Pyomo — Optimization Modeling in Python](https://link.springer.com/book/10.1007/978-3-030-68928-5)

* [Pyomo Workshop Slides](https://github.com/Pyomo/pyomo-tutorials/blob/main/Pyomo-Workshop-December-2023.pdf)

* [Prof. Jeffrey Kantor's Pyomo Cookbook](https://jckantor.github.io/ND-Pyomo-Cookbook/)

* The [companion notebooks](https://mobook.github.io/MO-book/intro.html)

  for *Hands-On Mathematical Optimization with Python*

* [Pyomo Gallery](https://github.com/Pyomo/PyomoGallery)



### Getting Help



To get help from the Pyomo community ask a question on one of the following:

* [Use the #pyomo tag on StackOverflow](https://stackoverflow.com/questions/ask?tags=pyomo)

* [Pyomo Forum](https://groups.google.com/forum/?hl=en#!forum/pyomo-forum)



### Developers



Pyomo development moved to this repository in June 2016 from

Sandia National Laboratories. Developer discussions are hosted by

[Google Groups](https://groups.google.com/forum/#!forum/pyomo-developers).



The Pyomo Development team holds weekly coordination meetings on

Tuesdays 12:30 - 14:00 (MT).  Please contact [email protected] to

request call-in information.



By contributing to this software project, you are agreeing to the

following terms and conditions for your contributions:



1. You agree your contributions are submitted under the BSD license. 

2. You represent you are authorized to make the contributions and grant

   the license. If your employer has rights to intellectual property that

   includes your contributions, you represent that you have received

   permission to make contributions and grant the required license on

   behalf of that employer.



### Related Packages



See https://pyomo.readthedocs.io/en/latest/related_packages.html.