Metadata-Version: 2.4
Name: cyipopt
Version: 1.7.0rc1
Summary: A Cython wrapper to the IPOPT optimization package
Home-page: https://github.com/mechmotum/cyipopt
Author: Jason K. Moore
Author-email: moorepants@gmail.com
License: EPL-2.0
Keywords: coin-or,interior-point,ipopt,nlp,nonlinear programming,optimization
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: Eclipse Public License 2.0 (EPL-2.0)
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
License-File: LICENSE
License-File: AUTHORS
Requires-Dist: numpy>=1.26.4
Provides-Extra: docs
Requires-Dist: numpydoc>=1.6.0; extra == "docs"
Requires-Dist: sphinx>=7.2.6; extra == "docs"
Provides-Extra: examples
Requires-Dist: jax>=0.4.26; extra == "examples"
Requires-Dist: matplotlib>=3.6.3; extra == "examples"
Requires-Dist: scipy>=1.11.4; extra == "examples"
Provides-Extra: tests
Requires-Dist: pytest>=7.4.4; extra == "tests"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: summary

==================
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 due to the
indeterminate copyright license of such code. 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
