================== README for cyipopt

Ipopt_ (Interior Point OPTimizer, pronounced eye-pea-opt) is a software package for large-scale nonlinear optimization. Ipopt is available from the COIN-OR_ initiative, under the Eclipse Public License (EPL).

cyipopt is a Python wrapper around Ipopt. It enables using Ipopt from the comfort of the Python programming language.

.. _Ipopt: https://projects.coin-or.org/Ipopt .. _COIN-OR: https://projects.coin-or.org/

Status

.. list-table::

• • Anaconda
  • .. image:: https://anaconda.org/conda-forge/cyipopt/badges/version.svg :target: https://anaconda.org/conda-forge/cyipopt .. image:: https://anaconda.org/conda-forge/cyipopt/badges/downloads.svg :target: https://anaconda.org/conda-forge/cyipopt
• • PyPI
  • .. image:: https://badge.fury.io/py/cyipopt.svg :target: https://pypi.org/project/cyipopt .. image:: https://pepy.tech/badge/cyipopt :target: https://pypi.org/project/cyipopt
• • Read the Docs
  • .. image:: https://readthedocs.org/projects/cyipopt/badge/?version=latest :target: https://cyipopt.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status

History

This repository was forked in 2016 from https://bitbucket.org/amitibo/cyipopt and is now considered the primary repository. The fork includes a SciPy-style interface and ability to handle exceptions in the callback functions.

As of version 1.1.0 (2021-09-07), the distribution is released under the name "cyipopt" on PyPi (https://pypi.org/project/cyipopt). Before version 1.1.0, it was released under the name "ipopt" (https://pypi.org/project/ipopt).

Installation

We recommend using conda to install cyipopt on Linux, Mac, and Windows::

conda install -c conda-forge cyipopt

Other installation options_ are present in the documentation.

.. _installation options: https://github.com/mechmotum/cyipopt/blob/master/docs/source/install.rst

License

cyipopt is open-source code released under the EPL_ license, see the LICENSE file.

.. _EPL: https://www.eclipse.org/legal/epl-2.0/

Contributing

For bug reports, feature requests, comments, patches use the GitHub issue tracker and/or pull request system.

This project does not accept code produced from generative AI tools if the copyright license is indeterminate. Generative AI use in contributions must be fully disclosed and will be rejected unless there are no copyright concerns. Contributions that make use of generative AI for communication with the developers of this project will be rejected.

Contributors (made with contrib.rocks <https://contrib.rocks>_):

.. image:: https://contrib.rocks/image?repo=mechmotum/cyipopt :target: https://github.com/mechmotum/cyipopt/graphs/contributors