Merge pull request #189 from nrontsis/patch-4

Script for building manylinux wheels

README.rst

@@ -54,6 +54,23 @@ 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
 =======
 

build_manylinux_wheels.sh

@@ -0,0 +1,49 @@
+#!/bin/bash
+# Builds manylinux cyipopt wheels with Ipopt 3.14.11 based on MUMPS 5.5.1, and OpenBLAS 0.3.15
+set -eu  # Stop script if a line fails
+TAG=${1}
+echo "Building cyipopt with tag $TAG"
+
+# Install efficient BLAS & LAPACK library
+yum install -y openblas-devel-0.3.15-4.el8
+
+pushd /tmp
+
+# MUMPS (Linear solver used by Ipopt)
+git clone https://github.com/coin-or-tools/ThirdParty-Mumps --depth=1 --branch releases/3.0.4
+pushd ThirdParty-Mumps
+sh get.Mumps
+./configure --with-lapack="-L/usr/include/openblas -lopenblas"
+make
+make install
+popd
+
+
+# Ipopt (The solver itself)
+git clone https://github.com/coin-or/Ipopt --depth=1 --branch releases/3.14.11
+pushd Ipopt
+./configure --with-lapack="-L/usr/include/openblas -lopenblas"
+make
+make install
+popd
+
+# build cyipopt for many python versions
+git clone https://github.com/mechmotum/cyipopt --depth=1 --branch $TAG
+pushd cyipopt
+echo "------------------------------" >> LICENSE
+echo "This binary distribution of cyipopt also bundles the following software" >> LICENSE
+for bundled_license in licenses_manylinux_bundled_libraries/*.txt; do
+    cat $bundled_license >> LICENSE
+done
+for PYVERSION in "cp311-cp311" "cp310-cp310" "cp39-cp39" "cp38-cp38" "pp39-pypy39_pp73" "pp38-pypy38_pp73" ; do
+    /opt/python/$PYVERSION/bin/pip wheel --no-deps --wheel-dir=./dist .
+done
+for wheel in dist/cyipopt*; do
+    auditwheel repair $wheel  # Inject solver's shared libraries to wheel
+done
+for wheel in wheelhouse/*.whl; do
+    cp -rf $wheel /wheels/ # Copy repaired wheel to shared volume
+done
+popd
+
+popd

licenses_manylinux_bundled_libraries/README.md

@@ -0,0 +1 @@
+This folder contains licenses for all the libraries that are bundled in the `manylinux` wheels of `cyipopt`. These linceses are appended to `cyipopt`'s `LICENSE` file when building these wheels in `build_manylinux_wheel.sh`.

licenses_manylinux_bundled_libraries/gfortran.txt

@@ -0,0 +1,81 @@
+#############
+start of gfortran license
+applicable for bundled libraries: .libs/libgfortran*.so 
+license text obtained from https://github.com/gcc-mirror/gcc/blob/748086b7b2201112aff2dea9d037af1fc92567ff/COPYING.RUNTIME
+#############
+
+GCC RUNTIME LIBRARY EXCEPTION
+
+Version 3.1, 31 March 2009
+
+Copyright (C) 2009 Free Software Foundation, Inc. <http://fsf.org/>
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+This GCC Runtime Library Exception ("Exception") is an additional
+permission under section 7 of the GNU General Public License, version
+3 ("GPLv3"). It applies to a given file (the "Runtime Library") that
+bears a notice placed by the copyright holder of the file stating that
+the file is governed by GPLv3 along with this Exception.
+
+When you use GCC to compile a program, GCC may combine portions of
+certain GCC header files and runtime libraries with the compiled
+program. The purpose of this Exception is to allow compilation of
+non-GPL (including proprietary) programs to use, in this way, the
+header files and runtime libraries covered by this Exception.
+
+0. Definitions.
+
+A file is an "Independent Module" if it either requires the Runtime
+Library for execution after a Compilation Process, or makes use of an
+interface provided by the Runtime Library, but is not otherwise based
+on the Runtime Library.
+
+"GCC" means a version of the GNU Compiler Collection, with or without
+modifications, governed by version 3 (or a specified later version) of
+the GNU General Public License (GPL) with the option of using any
+subsequent versions published by the FSF.
+
+"GPL-compatible Software" is software whose conditions of propagation,
+modification and use would permit combination with GCC in accord with
+the license of GCC.
+
+"Target Code" refers to output from any compiler for a real or virtual
+target processor architecture, in executable form or suitable for
+input to an assembler, loader, linker and/or execution
+phase. Notwithstanding that, Target Code does not include data in any
+format that is used as a compiler intermediate representation, or used
+for producing a compiler intermediate representation.
+
+The "Compilation Process" transforms code entirely represented in
+non-intermediate languages designed for human-written code, and/or in
+Java Virtual Machine byte code, into Target Code. Thus, for example,
+use of source code generators and preprocessors need not be considered
+part of the Compilation Process, since the Compilation Process can be
+understood as starting with the output of the generators or
+preprocessors.
+
+A Compilation Process is "Eligible" if it is done using GCC, alone or
+with other GPL-compatible software, or if it is done without using any
+work based on GCC. For example, using non-GPL-compatible Software to
+optimize any GCC intermediate representations would not qualify as an
+Eligible Compilation Process.
+
+1. Grant of Additional Permission.
+
+You have permission to propagate a work of Target Code formed by
+combining the Runtime Library with Independent Modules, even if such
+propagation would otherwise violate the terms of GPLv3, provided that
+all Target Code was generated by Eligible Compilation Processes. You
+may then convey such a combination under terms of your choice,
+consistent with the licensing of the Independent Modules.
+
+2. No Weakening of GCC Copyleft.
+
+The availability of this Exception does not imply any general
+presumption that third-party software is unaffected by the copyleft
+requirements of the license of GCC.
+
+#############
+end of gfortran license