Installation¶

pip install xipopt

xipopt needs Python 3.11 or newer. Wheels exist for Linux (x86-64 and arm64), macOS on Apple silicon and Windows (x86-64). JAX publishes no recent wheels for Intel Macs, so there are none for xipopt either. The wheels contain Ipopt 3.14 with the sparse linear solvers MUMPS and SPRAL, OpenBLAS and the runtime libraries of the compiler, so the system needs no Ipopt or BLAS. cyxla and its CPU plugin come as dependencies, which means nothing downloads at run time.

Python and JAX versions¶

xipopt works with JAX 0.10 and 0.11. Release 0.5.2 of asdex, which detects sparsity, needs Python 3.12 and JAX 0.11, and does not import on JAX 0.12. Python 3.11 therefore installs JAX 0.10 and release 0.5.1 of asdex, which has the same interface for everything xipopt uses. The PJRT plugin of cyxla is a build of XLA 0.12 and compiles the StableHLO that these versions of JAX export.

Licenses¶

xipopt itself is under the Hippocratic License 3.0. The wheels also contain Ipopt (Eclipse Public License 2.0), MUMPS (CeCILL-C), SPRAL, METIS, OpenBLAS and a few smaller libraries, each under its own license. Every wheel carries a copy of them in its metadata, and the licenses directory of the repository lists them.

Building from source¶

The extension module links the Ipopt library of the Ipopt_jll package that Julia publishes. meson-jll turns it into Meson wraps. The repository commits only the lock file subprojects/meson-jll.lock.wrap, and the first configuration downloads meson-jll from its release and writes the wraps. You need a C compiler, and Meson fetches the rest.

git clone https://github.com/nardi/xipopt
cd xipopt
uv sync

The development page describes the checks that the repository runs.

Environment variables¶