alpaqa

Library for nonconvex constrained optimization using the augmented Lagrangian method and the matrix-free PANOC algorithm.

https://github.com/kul-optec/alpaqa

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
✓
Academic publication links
Links to: ieee.org
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (13.7%) to scientific vocabulary

Last synced: 6 months ago · JSON representation ·

Repository

Library for nonconvex constrained optimization using the augmented Lagrangian method and the matrix-free PANOC algorithm.

Basic Info

Host: GitHub
Owner: kul-optec
License: lgpl-3.0
Language: C++
Default Branch: develop
Size: 101 MB

Statistics

Stars: 79
Watchers: 5
Forks: 7
Open Issues: 3
Releases: 25

Created over 4 years ago · Last pushed 6 months ago

Metadata Files

Readme License Citation

alpaqa

alpaqa is an efficient implementation of an augmented Lagrangian method for general nonlinear programming problems, which uses the first-order, matrix-free PANOC algorithm as an inner solver.
The numerical algorithms themselves are implemented in C++ for optimal performance, and they are exposed as an easy-to-use Python package. An experimental MATLAB interface is available as well.

The solvers in this library solve minimization problems of the following form:

$$ \begin{equation} \begin{aligned} & \underset{x}{\textbf{minimize}} & & f(x) &&&& f : {\rm I\!R}^n \rightarrow {\rm I\!R} \ & \textbf{subject to} & & \underline{x} \le x \le \overline{x} \ &&& \underline{z} \le g(x) \le \overline{z} &&&& g : {\rm I\!R}^n \rightarrow {\rm I\!R}^m \end{aligned} \end{equation} $$

Documentation

Installation

The Python interface can be installed directly from PyPI:

sh python3 -m pip install --upgrade --pre alpaqa

For more information, please see the full installation instructions.

Publications

Pieter Pas, Mathijs Schuurmans, and Panagiotis Patrinos. Alpaqa: A matrix-free solver for nonlinear MPC and large-scale nonconvex optimization. In 2022 European Control Conference (ECC), pages 417–422, 2022.

Owner

Name: OPTEC
Login: kul-optec
Kind: organization

Repositories: 24
Profile: https://github.com/kul-optec

KU Leuven Center of Excellence: Optimization in Engineering

Citation (CITATION.cff)

cff-version: 1.2.0
title: alpaqa
message: >-
  If alpaqa proves useful in your research, please cite the
  following paper.
type: software
authors:
  - given-names: Pieter
    family-names: Pas
    orcid: 'https://orcid.org/0000-0002-7004-2447'
    affiliation: KU Leuven
  - given-names: Mathijs
    family-names: Schuurmans
    affiliation: KU Leuven
    orcid: 'https://orcid.org/0000-0001-8695-6473'
  - given-names: Alexander
    family-names: Bodard
    affiliation: KU Leuven
    orcid: 'https://orcid.org/0000-0001-7558-8249'
  - given-names: Panagiotis
    family-names: Patrinos
    affiliation: KU Leuven
repository-code: 'https://github.com/kul-optec/alpaqa'
url: 'https://kul-optec.github.io/alpaqa'
repository-artifact: 'https://pypi.org/project/alpaqa/'
keywords:
  - optimization
  - model predictive control
  - augmented lagrangian method
  - panoc
  - proximal algorithms
license: LGPL-3.0
preferred-citation:
  type: conference-paper
  authors:
    - given-names: Pieter
      family-names: Pas
      orcid: 'https://orcid.org/0000-0002-7004-2447'
      affiliation: KU Leuven
    - given-names: Mathijs
      family-names: Schuurmans
      affiliation: KU Leuven
      orcid: 'https://orcid.org/0000-0001-8695-6473'
    - given-names: Panagiotis
      family-names: Patrinos
      affiliation: KU Leuven
  title: >-
    Alpaqa: A matrix-free solver for nonlinear MPC and large-scale nonconvex
    optimization
  year: 2022
  collection-title: 2022 European Control Conference (ECC)
  conference:
    name: 2022 European Control Conference (ECC)
    city: London
    country: UK
    date-start: 2022-07-12
    date-end: 2022-07-15
  start: 417
  end: 422
  doi: 10.23919/ECC55457.2022.9838172
  url: 'https://arxiv.org/abs/2112.02370'

GitHub Events

Total

Release event: 2
Watch event: 10
Delete event: 1
Push event: 70
Create event: 3

Last Year

Release event: 2
Watch event: 10
Delete event: 1
Push event: 70
Create event: 3

Committers

Last synced: 10 months ago

All Time

Total Commits: 1,513
Total Committers: 5
Avg Commits per committer: 302.6
Development Distribution Score (DDS): 0.009

Past Year

Commits: 6
Committers: 1
Avg Commits per committer: 6.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
Pieter Pas	p**s@o**m	1,499
Mathijs Schuurmans	m**s@g**m	9
alexanderbodard	a**d@k**e	2
Pieter P	p**s@o**e	2
Joris Gillis	j**2@g**m	1

Committer Domains (Top 20 + Academic)

outlook.be: 1 kuleuven.be: 1

Issues and Pull Requests

Last synced: 7 months ago

All Time

Total issues: 5
Total pull requests: 5
Average time to close issues: 5 months
Average time to close pull requests: 2 months
Total issue authors: 4
Total pull request authors: 4
Average comments per issue: 2.6
Average comments per pull request: 0.6
Merged pull requests: 5
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 0
Pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

wcxily (2)
abdelhakim96 (1)
gelatinouscube42 (1)
truncs (1)

Pull Request Authors

tttapa (2)
alexanderbodard (1)
truncs (1)
gmsanchez (1)

Top Labels

Issue Labels

Pull Request Labels

Packages

Total packages: 2
Total downloads:
- pypi 3,048 last-month

Total dependent packages: 2
(may contain duplicates)
Total dependent repositories: 1
(may contain duplicates)
Total versions: 38
Total maintainers: 1

pypi.org: alpaqa

Augmented Lagrangian and PANOC solvers for nonconvex numerical optimization

Homepage: https://github.com/kul-optec/alpaqa
Documentation: https://kul-optec.github.io/alpaqa
License: GNU Lesser General Public License v3 (LGPLv3)
Latest release: 0.0.1
published over 3 years ago

Versions: 25
Dependent Packages: 1
Dependent Repositories: 1
Downloads: 2,774 Last month

Rankings

Downloads: 4.2%

Dependent packages count: 4.8%

Stargazers count: 10.0%

Average: 10.6%

Forks count: 12.5%

Dependent repos count: 21.5%

Maintainers (1)

pieterp

Last synced: 6 months ago

pypi.org: alpaqa-debug

Debug symbols for the alpaqa package.

Documentation: https://kul-optec.github.io/alpaqa
License: GNU LESSER GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below. 0. Additional Definitions. As used herein, "this License" refers to version 3 of the GNU Lesser General Public License, and the "GNU GPL" refers to version 3 of the GNU General Public License. "The Library" refers to a covered work governed by this License, other than an Application or a Combined Work as defined below. An "Application" is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library. A "Combined Work" is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the "Linked Version". The "Minimal Corresponding Source" for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version. The "Corresponding Application Code" for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work. 1. Exception to Section 3 of the GNU GPL. You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL. 2. Conveying Modified Versions. If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version: a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy. 3. Object Code Incorporating Material from Library Header Files. The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following: a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the object code with a copy of the GNU GPL and this license document. 4. Combined Works. You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following: a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the Combined Work with a copy of the GNU GPL and this license document. c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document. d) Do one of the following: 0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source. 1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version. e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.) 5. Combined Libraries. You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License. b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 6. Revised Versions of the GNU Lesser General Public License. The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation. If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library.
Latest release: 1.0.0a20
published about 1 year ago

Versions: 13
Dependent Packages: 1
Dependent Repositories: 0
Downloads: 274 Last month

Rankings

Dependent packages count: 7.5%

Stargazers count: 11.7%

Forks count: 14.4%

Average: 22.2%

Dependent repos count: 55.3%

Maintainers (1)

pieterp

Last synced: 6 months ago

Dependencies

scripts/requirements-docs.txt pypi

breathe *
casadi *
matplotlib *
numpy *

scripts/requirements-wheel.txt pypi

auditwheel *
build *
casadi *
cmake *
mypy *
ninja *
numpy *
pybind11 *
scikit-build *
setuptools >=42
wheel *

scripts/requirements.txt pypi

casadi *
numpy *

setup.py pypi

casadi *
cmake *
ninja *
numpy *

.github/workflows/wheel.yml actions

actions/cache v2 composite
actions/checkout v1 composite
actions/download-artifact v2 composite
actions/upload-artifact v2 composite

.github/workflows/documentation.yml actions

actions/cache v2 composite
actions/checkout v2 composite
actions/setup-python v2 composite

.github/workflows/tests.yml actions

actions/cache v2 composite
actions/checkout v1 composite
actions/setup-python v2 composite

.github/workflows/wheel-windows.yml actions

actions/cache v2 composite
actions/checkout v2 composite
actions/checkout v1 composite
actions/download-artifact v2 composite
actions/setup-python v2 composite
actions/upload-artifact v2 composite

scripts/ci/build-python-gcc/Dockerfile docker

ubuntu bionic build

alpaqa

Science Score: 54.0%

Repository

Basic Info

Statistics

Metadata Files

README.md

alpaqa

Documentation

Installation

Publications

Owner

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

pypi.org: alpaqa

Rankings

Maintainers (1)

pypi.org: alpaqa-debug

Rankings

Maintainers (1)

Dependencies