cbcbox 2.919

Binary distribution of the CBC MILP solver (COIN-OR Branch and Cut)

cbcbox

cbcbox is a high-performance, self-contained Python distribution of the CBC MILP solver (COIN-OR Branch and Cut), built from the latest COIN-OR master branch.

On x86_64 (Linux, macOS, Windows) the wheel ships both a Haswell-optimised binary (AVX2/FMA) for maximum speed and a generic build with runtime CPU dispatch for compatibility with any x86_64 machine — selected automatically. All dynamic dependencies (OpenBLAS, libgfortran, etc.) are bundled; no system libraries or separate installation steps are needed.

Highlights

• Haswell-optimised & generic builds — on x86_64 Linux, macOS, and Windows the wheel ships two complete solver stacks: a Haswell build (OpenBLAS AVX2/FMA kernel) for maximum throughput, and a generic build (DYNAMIC_ARCH runtime dispatch) for compatibility with any x86_64 CPU. The best available variant is selected automatically at import time (see Build variants).

• Parallel branch-and-cut — built with --enable-cbc-parallel. Use -threads=N to distribute the search tree across N threads, giving significant speedups on multi-core machines for hard MIP instances.

• AMD fill-reducing ordering — SuiteSparse AMD is compiled in, enabling the high-quality UniversityOfFlorida Cholesky factorization for Clp's barrier (interior point) solver. AMD reordering produces much less fill-in on large sparse problems than the built-in native Cholesky, making barrier substantially faster. Activate with -cholesky UniversityOfFlorida -barrier (see barrier usage).

Performance (x86_64)

Auto-updated by CI after each successful workflow run. Single-threaded solve time — lower is better.

Single-threaded solve time across benchmark instances on Linux x86_64. Speedup factor shown above each pair. Lower is better.

See also: Windows AMD64 + macOS x86_64 summary

Build variants

On x86_64 Linux, macOS, and Windows, the wheel ships two complete sets of binaries:

Variant	OpenBLAS kernel	Clp SIMD	Minimum CPU
generic	DYNAMIC_ARCH (runtime dispatch)	standard	any x86_64
avx2	HASWELL (256-bit AVX2/FMA)	-march=haswell -DCOIN_AVX2=4 (all Haswell ISA extensions + 4-double AVX2 layout)	Haswell (2013+)

At import time cbcbox automatically selects avx2 when it is available and the running CPU supports AVX2; otherwise it falls back to generic.

You can override this selection with the CBCBOX_BUILD environment variable:

# Force generic (portable) build
CBCBOX_BUILD=generic cbc mymodel.mps -solve -quit

# Force AVX2-optimised build (raises an error if not available)
CBCBOX_BUILD=avx2 cbc mymodel.mps -solve -quit

When CBCBOX_BUILD is set, a short summary of the selected build is printed to stdout on every call — useful for tagging experiment results:

[cbcbox] CBCBOX_BUILD=avx2
[cbcbox]   binary  : .../cbcbox/cbc_dist_avx2/bin/cbc
[cbcbox]   lib dir : .../cbcbox/cbc_dist_avx2/lib
[cbcbox]   libs    : libCbc.so.3, libClp.so.3, libopenblas.so.0

Non-x86_64 platforms (Linux aarch64, macOS arm64) ship the generic build only. CBCBOX_BUILD=avx2 will raise a RuntimeError on those platforms.

Local debug builds

The released wheels are fully optimised and stripped. To debug CBC itself (e.g. with GDB or LLDB), use the scripts in scripts/ to build a local debug-enabled binary. These produce the same full feature set as the release wheels (OpenBLAS, AMD, Nauty, pthreads) but compiled with -O1 -g and, on x86_64, with -march=haswell -DCOIN_AVX2=4 so you can debug AVX2-specific code paths.

Script	Platform	Environment	Output directory
scripts/build_debug.sh	Linux, macOS	native (host compiler)	cbc_dist_debug_avx2/ (x86_64) or cbc_dist_debug/ (ARM64)
scripts/build_debug_manylinux.sh	Linux	Docker — manylinux2014 container (exact CI parity)	same as above
scripts/build_debug_windows.ps1	Windows	MSYS2 / MinGW64	cbc_dist_debug_avx2\

Quick start

Linux / macOS (native build):

# x86_64 → debug + AVX2 → cbc_dist_debug_avx2/bin/cbc
# ARM64  → debug only  → cbc_dist_debug/bin/cbc
./scripts/build_debug.sh

# With AddressSanitizer:
./scripts/build_debug.sh --asan

# With ThreadSanitizer:
./scripts/build_debug.sh --tsan

# Force a clean rebuild from scratch (required when switching sanitizers):
./scripts/build_debug.sh --asan --clean

Linux (manylinux2014 container — matches CI exactly):

# Requires Docker; the script prints install instructions if it is missing.
./scripts/build_debug_manylinux.sh
./scripts/build_debug_manylinux.sh --asan
./scripts/build_debug_manylinux.sh --tsan

Windows (PowerShell):

# Requires MSYS2 at C:\msys64.  Note: sanitizers are not supported on Windows/MinGW.
.\scripts\build_debug_windows.ps1
.\scripts\build_debug_windows.ps1 -Clean   # force full rebuild

Debugging

# GDB (Linux):
gdb cbc_dist_debug_avx2/bin/cbc
(gdb) run mymodel.mps -solve -quit

# LLDB (macOS):
lldb cbc_dist_debug/bin/cbc
(lldb) run mymodel.mps -solve -quit

Sanitizer tips

Sanitizer	Flag	What it catches	Runtime env var
AddressSanitizer	--asan	heap/stack buffer overflows, use-after-free, memory leaks	ASAN_OPTIONS=detect_leaks=0 to suppress system-lib false positives
ThreadSanitizer	--tsan	data races between threads	TSAN_OPTIONS=halt_on_error=0 to log races without aborting

ASan and TSan are mutually exclusive. Neither is available on Windows/MinGW. Always pass --clean when switching from one sanitizer to another to avoid linking mismatched object files.

OpenBLAS is always built without sanitizer flags to avoid false positives from hand-optimised BLAS assembly; only the COIN-OR stack is instrumented.

Note: Debug binaries are not included in the published wheels because of their size. They are intended for local development only.

Supported platforms

Platform	Wheel tag
Linux x86_64	manylinux2014_x86_64
Linux aarch64	manylinux2014_aarch64
macOS arm64 (Apple Silicon)	macosx_11_0_arm64
macOS x86_64	macosx_10_9_x86_64
Windows AMD64	win_amd64

Installation

pip install cbcbox

Usage

Command line

After installation, CBC is available directly as the cbc command (pip installs the entry point into the environment's bin/ on Linux/macOS or Scripts/ on Windows, which is already on PATH):

cbc mymodel.lp -solve -quit
cbc mymodel.mps.gz -solve -quit
cbc mymodel.mps -seconds 60 -timem elapsed -solve -quit
cbc mymodel.mps -dualp pesteep -solve -quit

Alternatively, invoke via the Python module entry point:

python -m cbcbox mymodel.lp -solve -quit

CBC accepts LP, MPS and compressed MPS (.mps.gz) files. Pass -help for the full list of options, or -quit to exit after solving.

Parallel branch-and-cut

This build includes parallel branch-and-cut (--enable-cbc-parallel). Use -threads=N to distribute the search tree across N threads:

cbc mymodel.mps -threads=4 -solve -quit

Barrier (interior-point) solver

Clp's barrier solver can be faster than simplex for large LP relaxations. This build includes SuiteSparse AMD, which enables the high-quality UniversityOfFlorida Cholesky factorization — significantly reducing fill-in compared to the built-in native Cholesky:

# Solve LP relaxation with barrier + AMD Cholesky, then crossover to simplex basis
cbc mymodel.mps -cholesky UniversityOfFlorida -barrier -solve -quit

# Useful as a root-node strategy inside MIP (let CBC use simplex for B&B):
cbc mymodel.mps -cholesky UniversityOfFlorida -barrier -solve -quit

Without AMD, only -cholesky native (less efficient) is available.

Python API

The package exposes helpers to locate the installed files:

import cbcbox
import subprocess

# Path to the cbc binary (cbc.exe on Windows).
cbcbox.cbc_bin_path()
# e.g. '/home/user/.venv/lib/python3.13/site-packages/cbcbox/cbc_dist/bin/cbc'

# Directory containing the shared libraries.
cbcbox.cbc_lib_dir()
# e.g. '.../cbcbox/cbc_dist/lib'

# Directory containing the COIN-OR C/C++ headers.
cbcbox.cbc_include_dir()
# e.g. '.../cbcbox/cbc_dist/include/coin'

# Run CBC programmatically.
result = subprocess.run(
    [cbcbox.cbc_bin_path(), "mymodel.mps", "-solve", "-quit"],
    capture_output=True, text=True,
)
print(result.stdout)

What is built

The build pipeline compiles all components from source inside the CI runner, in the following order:

Component	Version / branch	Purpose
Cbc	master	Branch-and-cut MIP solver
Cgl	master	Cut generation library
Clp	master	Simplex LP solver (used as the MIP node relaxation)
Osi	master	Open Solver Interface
CoinUtils	master	Utility library (shared by all COIN-OR packages)
Nauty	2.8.9	Symmetry detection for MIP presolve
AMD (SuiteSparse v7.12.2)	v7.12.2	Sparse matrix fill-reducing ordering
OpenBLAS	v0.3.31	Optimised BLAS/LAPACK for LP basis factorisation

On x86_64 Linux, macOS, and Windows the entire stack is compiled twice: once for the generic variant (OpenBLAS DYNAMIC_ARCH=1) and once for the avx2 variant (TARGET=HASWELL, CXXFLAGS=-O3 -march=haswell -DCOIN_AVX2=4). AMD and Nauty are built only once (they are pure combinatorial code with no BLAS dependency) and reused by both COIN-OR variants.

All COIN-OR components are built as shared (.so / .dylib / .dll) libraries. The shared libraries are patched with self-relative RPATHs and bundled inside the wheel, making them directly usable via cffi or ctypes without any system installation.

Wheel contents

The wheel installs under cbcbox/ inside the site-packages directory. On x86_64 Linux, macOS, and Windows it contains two dist trees; other platforms contain only cbc_dist/:

cbc_dist/           ← generic build (all platforms)
cbc_dist_avx2/      ← AVX2-optimised build (x86_64 Linux/macOS/Windows)
├── bin/
│   ├── cbc           # CBC MIP solver binary  (cbc.exe on Windows)
│   └── clp           # Clp LP solver binary   (clp.exe on Windows)
├── lib/
│   ├── libCbc.so / libCbc.dylib / libCbc.dll  # CBC solver
│   ├── libCbcSolver.so ...
│   ├── libClp.so ...                          # Clp LP solver
│   ├── libCgl.so ...                          # Cut generation
│   ├── libOsi.so ...                          # Solver interface
│   ├── libOsiClp.so ...                       # Clp OSI binding
│   ├── libOsiCbc.so ...                       # CBC OSI binding (where available)
│   ├── libCoinUtils.so ...
│   ├── libopenblas.so / .dylib / .dll         # OpenBLAS BLAS/LAPACK
│   ├── pkgconfig/                             # .pc files for all libraries
│   └── <bundled runtime shared libs>          # Platform-specific — see below
└── include/
    ├── coin/      # COIN-OR headers (CoinUtils, Osi, Clp, Cgl, Cbc)
    ├── nauty/     # Nauty headers
    └── *.h        # SuiteSparse / AMD headers

Bundled dynamic libraries

Because OpenBLAS links to the Fortran runtime, the following shared libraries are bundled inside the wheel and their paths are rewritten so no system installation is required.

Linux (lib/ directory, RPATH set to $ORIGIN)

Library	Description
libopenblas.so.0	OpenBLAS BLAS/LAPACK
libgfortran.so.5	GNU Fortran runtime
libquadmath.so.0	Quad-precision math (dependency of libgfortran)

macOS (lib/ directory, install names rewritten to @rpath/)

Library	Description
libopenblas.dylib	OpenBLAS BLAS/LAPACK
libgfortran.5.dylib	GNU Fortran runtime
libgcc_s.1.1.dylib	GCC runtime
libquadmath.0.dylib	Quad-precision math

Windows (bin/ directory, DLLs placed next to the executable)

Library	Description
libopenblas.dll	OpenBLAS BLAS/LAPACK
libgfortran-5.dll	GNU Fortran runtime
libgcc_s_seh-1.dll	GCC SEH runtime
libquadmath-0.dll	Quad-precision math
libstdc++-6.dll	C++ standard library (MinGW64)
libwinpthread-1.dll	POSIX thread emulation

CI / build pipeline

Wheels are built and tested automatically via GitHub Actions using cibuildwheel. The workflow (.github/workflows/wheel.yml) runs independent compile jobs in parallel, then packages each platform:

Compile jobs	Runner	Produces
compile-linux-x64-generic + compile-linux-x64-avx2	ubuntu-latest	manylinux2014_x86_64 wheel
compile-linux-arm64-generic	ubuntu-24.04-arm	manylinux2014_aarch64 wheel
compile-macos-arm64-generic	macos-15	macosx_11_0_arm64 wheel
compile-macos-intel-generic + compile-macos-intel-avx2	macos-15-intel	macosx_10_9_x86_64 wheel
compile-windows-generic + compile-windows-avx2	windows-latest	win_amd64 wheel

Each platform's compile jobs run in parallel. Once all compile jobs for a platform finish, the corresponding package-* job assembles the wheel via cibuildwheel and runs the test suite against the installed wheel.

A final combine_reports job collects per-platform performance results and commits the updated README.md to the repository.

Integration tests

The test suite (pytest) solves fifteen MIP instances and checks the optimal objective values, in both single-threaded and parallel (3-thread) modes. On x86_64 Linux, macOS, and Windows each test is run twice — once against the generic binary and once against the avx2 binary — and a side-by-side performance comparison is recorded:

Instance	Expected optimal	Time limit
pp08a.mps.gz	7 350	2000 s
sprint_hidden06_j.mps.gz	130	2000 s
air03.mps.gz	340 160	2000 s
air04.mps.gz	56 137	2000 s
air05.mps.gz	26 374	2000 s
nw04.mps.gz	16 862	2000 s
mzzv11.mps.gz	−21 718	2000 s
trd445c.mps.gz	−153 419.078836	2000 s
nursesched-sprint02.mps.gz	58	2000 s
stein45.mps.gz	30	2000 s
neos-810286.mps.gz	2 877	2000 s
neos-1281048.mps.gz	601	2000 s
j3050_8.mps.gz	1	2000 s
qiu.mps.gz	−132.873136947	2000 s
gesa2-o.mps.gz	25 779 856.3717	2000 s

Time limits are generous to avoid false failures on slow CI runners.

Performance results

Auto-updated by CI after each successful workflow run.

Summary

Geometric mean solve time (seconds) across all test instances.

1 thread

Platform	generic (s)
Darwin arm64	41.63

3 threads

Platform	generic (s)
Darwin arm64	35.34

Per-instance results

pp08a.mps.gz

Platform	Build	1 thread (s)	3 threads (s)	parallel speedup
Darwin arm64	generic	10.85	18.78	0.58×

sprint_hidden06_j.mps.gz

Platform	Build	1 thread (s)	3 threads (s)	parallel speedup
Darwin arm64	generic	149.73	115.76	1.29×

air03.mps.gz

Platform	Build	1 thread (s)	3 threads (s)	parallel speedup
Darwin arm64	generic	5.76	4.67	1.23×

air04.mps.gz

Platform	Build	1 thread (s)	3 threads (s)	parallel speedup
Darwin arm64	generic	134.82	84.52	1.60×

air05.mps.gz

Platform	Build	1 thread (s)	3 threads (s)	parallel speedup
Darwin arm64	generic	62.26	37.39	1.66×

nw04.mps.gz

Platform	Build	1 thread (s)	3 threads (s)	parallel speedup
Darwin arm64	generic	40.25	34.57	1.16×

mzzv11.mps.gz

Platform	Build	1 thread (s)	3 threads (s)	parallel speedup
Darwin arm64	generic	292.51	201.58	1.45×

trd445c.mps.gz

Platform	Build	1 thread (s)	3 threads (s)	parallel speedup
Darwin arm64	generic	190.59	220.08	0.87×

nursesched-sprint02.mps.gz

Platform	Build	1 thread (s)	3 threads (s)	parallel speedup
Darwin arm64	generic	89.78	118.33	0.76×

stein45.mps.gz

Platform	Build	1 thread (s)	3 threads (s)	parallel speedup
Darwin arm64	generic	18.80	14.49	1.30×

neos-810286.mps.gz

Platform	Build	1 thread (s)	3 threads (s)	parallel speedup
Darwin arm64	generic	24.87	27.18	0.92×

neos-1281048.mps.gz

Platform	Build	1 thread (s)	3 threads (s)	parallel speedup
Darwin arm64	generic	37.94	20.82	1.82×

j3050_8.mps.gz

Platform	Build	1 thread (s)	3 threads (s)	parallel speedup
Darwin arm64	generic	7.22	6.91	1.05×

qiu.mps.gz

Platform	Build	1 thread (s)	3 threads (s)	parallel speedup
Darwin arm64	generic	83.39	28.37	2.94×

gesa2-o.mps.gz

Platform	Build	1 thread (s)	3 threads (s)	parallel speedup
Darwin arm64	generic	9.05	10.02	0.90×

pk1.mps.gz

Platform	Build	1 thread (s)	3 threads (s)	parallel speedup
Darwin arm64	generic	63.40	51.16	1.24×

mas76.mps.gz

Platform	Build	1 thread (s)	3 threads (s)	parallel speedup
Darwin arm64	generic	39.70	47.86	0.83×

app1-1.mps.gz

Platform	Build	1 thread (s)	3 threads (s)	parallel speedup
Darwin arm64	generic	13.53	18.92	0.71×

eil33-2.mps.gz

Platform	Build	1 thread (s)	3 threads (s)	parallel speedup
Darwin arm64	generic	112.60	60.31	1.87×

NAQ — Never Asked Questions

Why not benchmark on the full MIPLIB 2017 library?

Several practical constraints shape the benchmark set:

1. CI time limits. GitHub Actions enforces a 6-hour wall-clock limit per job. The full MIPLIB 2017 collection contains ~240 instances, many of which take hours even on fast hardware. Including all of them would make every CI run time out before producing any useful measurements.

2. Comparing apples to apples requires instances solved to optimality. If some instances are only solved within a time limit (i.e., a gap > 0 %), a meaningful performance comparison must account for both solve time and solution quality simultaneously. This greatly complicates analysis and makes plots harder to interpret. Restricting to instances that CBC reliably solves to proven optimality keeps the comparison clean: a single elapsed-time number per instance is all that is needed.

3. The instance set is intentionally biased toward set packing / covering / partitioning structure. Most instances in the benchmark (pp08a, sprint_hidden06_j, nw04, mzzv11, nursesched-sprint02, air0x, trd445c) contain large blocks of set packing, covering, or partitioning constraints. This structure arises naturally in applications such as crew scheduling, nurse scheduling, vehicle routing, and cutting stock — exactly the domain where column generation is most valuable. Since the benchmark focuses on this problem class rather than providing a general-purpose solver survey, it is a specially interesting use case.

License

CBC and all COIN-OR components are distributed under the Eclipse Public License 2.0. OpenBLAS is distributed under the BSD 3-Clause licence. SuiteSparse AMD is distributed under the BSD 3-Clause licence. Nauty is distributed under the Apache 2.0 licence.