==================
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
Building `manylinux` wheels
===========================
manylinux wheels can be built for a tagged version (GIT_TAG below) of cyipopt via docker by running (while in the root of this repo)::
docker run -v $(pwd):/wheels --rm --platform=linux/amd64 quay.io/pypa/manylinux_2_28_x86_64 bash /wheels/build_manylinux_wheels.sh GIT_TAG
for linux/amd64 and::
docker run -v $(pwd):/wheels --rm --platform=linux/aarch64 quay.io/pypa/manylinux_2_28_aarch64 bash /wheels/build_manylinux_wheels.sh GIT_TAG
for linux/aarch64 platforms. Built wheels appear at the folder the command was executed from.
.. warning::
Docker supports emulating non-native platforms to e.g. produce ARM binaries from an AMD64 host. However this can be quite slow (~1h for our case).
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.
Raw data
{
"_id": null,
"home_page": "https://github.com/mechmotum/cyipopt",
"name": "cyipopt",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "coin-or, interior-point, ipopt, nlp, nonlinear programming, optimization",
"author": "Jason K. Moore",
"author_email": "moorepants@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/31/df/f985c9325b5ae0a1a5fa640b3ca8d04a18987e035d03ab62acd6dfd31e49/cyipopt-1.5.0.tar.gz",
"platform": null,
"description": "==================\nREADME for cyipopt\n==================\n\nIpopt_ (Interior Point OPTimizer, pronounced eye-pea-opt) is a software package\nfor large-scale nonlinear optimization. Ipopt is available from the COIN-OR_\ninitiative, under the Eclipse Public License (EPL).\n\n**cyipopt** is a Python wrapper around Ipopt. It enables using Ipopt from the\ncomfort of the Python programming language.\n\n.. _Ipopt: https://projects.coin-or.org/Ipopt\n.. _COIN-OR: https://projects.coin-or.org/\n\nStatus\n======\n\n.. list-table::\n\n * - Anaconda\n - .. image:: https://anaconda.org/conda-forge/cyipopt/badges/version.svg\n :target: https://anaconda.org/conda-forge/cyipopt\n .. image:: https://anaconda.org/conda-forge/cyipopt/badges/downloads.svg\n :target: https://anaconda.org/conda-forge/cyipopt\n * - PyPI\n - .. image:: https://badge.fury.io/py/cyipopt.svg\n :target: https://pypi.org/project/cyipopt\n .. image:: https://pepy.tech/badge/cyipopt\n :target: https://pypi.org/project/cyipopt\n * - Read the Docs\n - .. image:: https://readthedocs.org/projects/cyipopt/badge/?version=latest\n :target: https://cyipopt.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\nHistory\n=======\n\n**This repository was forked in 2016 from https://bitbucket.org/amitibo/cyipopt\nand is now considered the primary repository.** The fork includes a SciPy-style\ninterface and ability to handle exceptions in the callback functions.\n\nAs of version 1.1.0 (2021-09-07), the distribution is released under the name\n\"cyipopt\" on PyPi (https://pypi.org/project/cyipopt). Before version 1.1.0, it\nwas released under the name \"ipopt\" (https://pypi.org/project/ipopt).\n\nInstallation\n============\n\nWe recommend using conda to install cyipopt on Linux, Mac, and Windows::\n\n conda install -c conda-forge cyipopt\n\nOther `installation options`_ are present in the documentation.\n\n.. _installation options: https://github.com/mechmotum/cyipopt/blob/master/docs/source/install.rst\n\n\nBuilding `manylinux` wheels\n===========================\n\nmanylinux wheels can be built for a tagged version (GIT_TAG below) of cyipopt via docker by running (while in the root of this repo)::\n\n docker run -v $(pwd):/wheels --rm --platform=linux/amd64 quay.io/pypa/manylinux_2_28_x86_64 bash /wheels/build_manylinux_wheels.sh GIT_TAG\n\nfor linux/amd64 and::\n\n docker run -v $(pwd):/wheels --rm --platform=linux/aarch64 quay.io/pypa/manylinux_2_28_aarch64 bash /wheels/build_manylinux_wheels.sh GIT_TAG\n\nfor linux/aarch64 platforms. Built wheels appear at the folder the command was executed from.\n\n.. warning::\n Docker supports emulating non-native platforms to e.g. produce ARM binaries from an AMD64 host. However this can be quite slow (~1h for our case).\n\nLicense\n=======\n\ncyipopt is open-source code released under the EPL_ license, see the\n``LICENSE`` file.\n\n.. _EPL: https://www.eclipse.org/legal/epl-2.0/\n\nContributing\n============\n\nFor bug reports, feature requests, comments, patches use the GitHub issue\ntracker and/or pull request system.\n",
"bugtrack_url": null,
"license": "EPL-2.0",
"summary": "A Cython wrapper to the IPOPT optimization package",
"version": "1.5.0",
"project_urls": {
"Homepage": "https://github.com/mechmotum/cyipopt"
},
"split_keywords": [
"coin-or",
" interior-point",
" ipopt",
" nlp",
" nonlinear programming",
" optimization"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "31dff985c9325b5ae0a1a5fa640b3ca8d04a18987e035d03ab62acd6dfd31e49",
"md5": "c2632dd1ef7ab7997a45f93394e1212d",
"sha256": "8c6f9c1081aa754c6f84d9f2842bd0d4e4ad466a567f0d4675b124d681eec1dc"
},
"downloads": -1,
"filename": "cyipopt-1.5.0.tar.gz",
"has_sig": false,
"md5_digest": "c2632dd1ef7ab7997a45f93394e1212d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 68215,
"upload_time": "2024-09-08T12:29:47",
"upload_time_iso_8601": "2024-09-08T12:29:47.169830Z",
"url": "https://files.pythonhosted.org/packages/31/df/f985c9325b5ae0a1a5fa640b3ca8d04a18987e035d03ab62acd6dfd31e49/cyipopt-1.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-08 12:29:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mechmotum",
"github_project": "cyipopt",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "cyipopt"
}
JSON
