kul-optec / alpaqa

Library for nonconvex constrained optimization using the augmented Lagrangian method and the matrix-free PANOC algorithm.
GNU Lesser General Public License v3.0
64 stars 7 forks source link

pip install broken? #11

Open gelatinouscube42 opened 2 months ago

gelatinouscube42 commented 2 months ago

Using vanilla `pip install alpaqa' installs alpaqa version 0.0.1 successfully. However, that distribution does not seem to work with the documented examples from the site, in particular the HangingChain MPC. Seems to me the python API is broken/missing...could not import the alpaqa.minimize function, nor the class it wraps.

Using the --upgrade --pre flags does fix this issue. Is there a reason that a version 0.0.2 is not yet released with whatever changes fixed this?

tttapa commented 2 months ago

The alpaqa.minimize function was added after 0.0.1. To use version 0.0.1, you'll have to use the documentation and examples for that specific release. (You can find them here: https://github.com/kul-optec/alpaqa/tree/main/examples/mpc/python/hanging-chain.)

That being said, I would highly recommend using the pre-release versions for 1.0.0 (using pip install --pre alpaqa), as the 0.0.1 version is pretty outdated at this point (over 1100 commits and counting).
I'm planning a 1.0.0 release once the API is finalized.