Installation guide

Contents

• Precompiled libraries and executables
• Dependencies
• Compiling and installing Uno from source
• CMake options

Precompiled libraries and executables

We provide precompiled Uno libraries and executables in the releases tab for Linux (x64 and aarch64), macOS (x64 and aarch64), and Windows (x64).

On some platforms, the dynamic linker needs to know where to look for libraries at runtime. You might need to set the following environment variables:

• LD_LIBRARY_PATH on Linux
• DYLD_LIBRARY_PATH or DYLD_FALLBACK_LIBRARY_PATH on macOS
• PATH on Windows

These variables should include the directories where you extracted the library files. For all platforms, the environment variable PATH is needed to locate the binary uno_ampl / uno_ampl.exe:

=== "Linux"

```console
tar -xzf Uno.vX.Y.Z.linux.tar.gz
export LD_LIBRARY_PATH=/path/to/extracted/Uno/lib:/path/to/extracted/Uno/deps:$LD_LIBRARY_PATH
export PATH=/path/to/extracted/Uno/bin:$PATH
```

=== "macOS"

```console
tar -xzf Uno.vX.Y.Z.macos.tar.gz
export DYLD_LIBRARY_PATH=/path/to/extracted/Uno/lib:/path/to/extracted/Uno/deps:$DYLD_LIBRARY_PATH
export PATH=/path/to/extracted/Uno/bin:$PATH
```

=== "Windows (PowerShell)"

```console
tar -xzf Uno.vX.Y.Z.windows.zip
$env:PATH="C:\path\to\extracted\Uno\bin;C:\path\to\extracted\Uno\lib;C:\path\to\extracted\Uno\deps;$env:PATH"
```

=== "Windows (Command Prompt)"

```console
tar -xzf Uno.vX.Y.Z.windows.zip
set PATH=C:\path\to\extracted\Uno\bin;C:\path\to\extracted\Uno\lib;C:\path\to\extracted\Uno\deps;%PATH%
```

Dependencies

• install cmake, BLAS and LAPACK:

sudo apt update
sudo apt install cmake
sudo apt install libblas-dev liblapack-dev

• (optional) download the AMPL solver library (ASL)

• (optional) download solvers:

  • BQPD (null-space active set solver for nonconvex quadratic programming): get a precompiled binary for your architecture or get in touch with Sven Leyffer to apply for an academic license
  • MA27 (sparse indefinite symmetric linear solver)
  • MA57 (sparse indefinite symmetric linear solver)
  • MA86 (sparse indefinite symmetric linear solver)
  • LIBHSL (collection of solvers for sparse linear systems)
  • MUMPS (sparse indefinite symmetric linear solver)
  • SSIDS (sparse indefinite symmetric linear solver) from the SPRAL library
  • HiGHS (linear programming and convex quadratic programming solver)

• to compile MUMPS in sequential mode, remove the flag -fopenmp at the end of your Makefile.inc and set the following variables:

INCS = $(INCSEQ)
LIBS = $(LIBSEQ)
LIBSEQNEEDED = libseqneeded

• compile SSIDS without OpenMP with the Meson flag -Dopenmp=false

• you may experience a short lag at startup (about 1/4s) when running Uno with SSIDS. This is due to hwloc (hardware locality), a tool that aims at discovering hardware resources in parallel architectures. To precompute the required topology, run the following commands before running Uno:

lstopo --of xml ~/.config/hwloc-topology.xml
echo 'export HWLOC_XMLFILE=$HOME/.config/hwloc-topology.xml' >> ~/.bashrc

Compiling and installing Uno from source

The sequence of commands to configure and build is as follows (assuming the build directory is build):

cmake -S . -B build [options]
cmake --build build --parallel

See the list of CMake options here.

To install the built libraries and headers:

cmake --install build

To configure, compile and run the test suite:

cmake -S . -B build -DENABLE_TESTS=ON
cmake --build build --target run_unotest --parallel
ctest --test-dir build

CMake options

You can pass the following options as -DOPTION=value:

Option	Description	Possible values
CMAKE_BUILD_TYPE	build type	Release, Debug
ENABLE_TESTS	enable the unit tests	ON, OFF
BUILD_STATIC_LIBS	build the Uno static library	ON, OFF
BUILD_SHARED_LIBS	build the Uno shared library	ON, OFF
LAPACK_LIBRARIES	path(s) to the LAPACK library, separated by ;	paths
BLAS_LIBRARIES	path(s) to the BLAS library, separated by ;	paths
AMPLSOLVER	path(s) to the ASL library	path_to_libamplsolver
BQPD	path to the BQPD library	path_to_libbqpd
MA27	path to the MA27 library	path_to_libma27
MA57	path to the MA57 library	path_to_libma57
MA86	path to the MA86 library	path_to_libma86
HSL	path to the HSL library	path_to_libhsl
HSL_RUNTIME_LOADING	load HSL linear solvers at runtime via dlopen; requires BUILD_SHARED_LIBS=ON	ON, OFF
HIGHS	path to the HiGHS libraries (typically libhighs and libhighs_extras)	path_to_libhighs
HIGHS_INCLUDE_DIR	path to HiGHS include directory	path_to_highs_include_dir
METIS	path to the METIS library	path_to_libmetis
MUMPS_LIBRARY	path to the MUMPS library	path_to_libdmumps
MUMPS_COMMON_LIBRARY	path to the MUMPS common library	path_to_libmumps_common
MUMPS_PORD_LIBRARY	path to the MUMPS PORD library	path_to_libpord
MUMPS_MPISEQ_LIBRARY	path to the MUMPS MPISEQ library	path_to_libmpiseq
MUMPS_INCLUDE_DIR	path to MUMPS include directory	path_to_mumps_include_dir
SPRAL	path to SPRAL library (requires libhwloc passed to AUXILIARY_LIBRARIES)	path_to_libspral
SPRAL_INCLUDE_DIR	path to SPRAL include directory	path_to_spral_include_dir
AUXILIARY_LIBRARIES	path(s) to additional libraries to link against, separated by ; (e.g., libhwloc and libstdc++)	paths