Skip to content

ERGO-Code/HiGHS

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Repository files navigation

HiGHS - Linear optimization software

Build Status Build Status Build Status Build Status
Conan Center
PyPi PyPi
NuGet version NuGet download

About HiGHS

HiGHS is a high performance serial and parallel solver for large scale sparse linear optimization problems of the form

$$ \min \quad \dfrac{1}{2}x^TQx + c^Tx \qquad \textrm{s.t.}~ \quad L \leq Ax \leq U; \quad l \leq x \leq u $$

where Q must be positive semi-definite and, if Q is zero, there may be a requirement that some of the variables take integer values. Thus HiGHS can solve linear programming (LP) problems, convex quadratic programming (QP) problems, and mixed integer programming (MIP) problems. It is mainly written in C++, but also has some C. It has been developed and tested on various Linux, MacOS and Windows installations. No third-party dependencies are required.

HiGHS has primal and dual revised simplex solvers, originally written by Qi Huangfu and further developed by Julian Hall. It also has an interior point solver for LP written by Lukas Schork, an active set solver for QP written by Michael Feldmeier, and a MIP solver written by Leona Gottwald. Other features have been added by Julian Hall and Ivet Galabova, who manages the software engineering of HiGHS and interfaces to C, C#, FORTRAN, Julia and Python.

Find out more about HiGHS athttps:// highs.dev.

Although HiGHS is freely available under the MIT license, we would be pleased to learn about users' experience and give advice via email sent tohighsopt@gmail.

Documentation

Documentation is available athttps://ergo-code.github.io/HiGHS/.

Installation

Build from source using CMake

HiGHS uses CMake as build system, and requires at least version 3.15. To generate build files in a new subdirectory called 'build', run:

cmake -S.-B build
cmake --build build

This installs the executablebin/highsand the librarylib/highs.

To test whether the compilation was successful, change into the build directory and run

ctest

More details on building with CMake can be found inHiGHS/cmake/README.md.

Build with Meson

As an alternative, HiGHS can be installed using themesonbuild interface:

meson setup bbdir -Dwith_tests=True
mesontest-C bbdir

The meson build files are provided by the community and are not officially supported by the HiGHS development team.

Build with Nix

There is a nix flake that provides thehighsbinary:

nix run.

You can even runwithout installing anything,supposing you have installednix:

nix run github:ERGO-Code/HiGHS

The nix flake also provides the Python package:

nix build.#highspy
tree result/

And a devShell for testing it:

nix develop.#highspy
Python
>>> import highspy
>>>highspy.Highs()

The nix build files are provided by the community and are not officially supported by the HiGHS development team.

Precompiled binaries

Precompiled static executables are available for a variety of platforms at https://github /JuliaBinaryWrappers/HiGHSstatic_jll.jl/releases

These binaries are provided by the Julia community and are not officially supported by the HiGHS development team. If you have trouble using these libraries, please open a GitHub issue and tag@odowin your question.

Seehttps://ergo-code.github.io/HiGHS/stable/installation/#Precompiled-Binaries.

Running HiGHS

HiGHS can read MPS files and (CPLEX) LP files, and the following command solves the model inml.mps

highs ml.mps

Command line options

When HiGHS is run from the command line, some fundamental option values may be specified directly. Many more may be specified via a file. Formally, the usage is:

$ bin/highs --help
HiGHS options
Usage:
bin/highs [OPTION...] [file]

--model_file arg File of model to solve.
--read_solution_file arg File of solution to read.
--options_file arg File containing HiGHS options.
--presolve arg Presolve: "choose" by default - "on" / "off"
are alternatives.
--solver arg Solver: "choose" by default - "simplex" / "ipm"
are alternatives.
--parallel arg Parallel solve: "choose" by default -
"on" / "off" are alternatives.
--run_crossover arg Run crossover: "on" by default -
"choose" / "off" are alternatives.
--time_limit arg Run time limit (seconds - double).
--solution_file arg File for writing out model solution.
--write_model_file arg File for writing out model.
--random_seed arg Seed to initialize random number generation.
--ranging arg Compute cost, bound, RHS and basic solution
ranging.
--version Print version.
-h, --help Print help.

For a full list of options, see theoptions pageof the documentation website.

Interfaces

There are HiGHS interfaces for C, C#, FORTRAN, and Python inHiGHS/src/interfaces,with example driver files inHiGHS/examples/.More on language and modelling interfaces can be found athttps://ergo-code.github.io/HiGHS/stable/interfaces/other/.

We are happy to give a reasonable level of support via email sent tohighsopt@gmail.

Python

The Python packagehighspyis a thin wrapper around HiGHS and is available onPyPi.It can be easily installed viapipby running

$ pip install highspy

Alternatively,highspycan be built from source. Download the HiGHS source code and run

pip install.

from the root directory.

The HiGHS C++ library no longer needs to be separately installed. The Python packagehighspydepends on thenumpypackage andnumpywill be installed as well, if it is not already present.

The installation can be tested using the small exampleHiGHS/examples/call_highs_from_ Python _highspy.py.

TheGoogle Colab Example Notebookalso demonstrates how to callhighspy.

C

The C API is inHiGHS/src/interfaces/highs_c_api.h.It is included in the default build. For more details, check out the documentation websitehttps://ergo-code.github.io/HiGHS/.

CSharp

The nuget package Highs.Native is onhttps:// nuget.org,athttps:// nuget.org/packages/Highs.Native/.

It can be added to your C# project withdotnet

dotnet add package Highs.Native --version 1.7.2

The nuget package contains runtime libraries for

  • win-x64
  • win-x32
  • linux-x64
  • linux-arm64
  • macos-x64
  • macos-arm64

Details for building locally can be found innuget/README.md.

Fortran

The Fortran API is inHiGHS/src/interfaces/highs_fortran_api.f90.It isnotincluded in the default build. For more details, check out the documentation websitehttps://ergo-code.github.io/HiGHS/.

Reference

If you use HiGHS in an academic context, please acknowledge this and cite the following article.

Parallelizing the dual revised simplex method Q. Huangfu and J. A. J. Hall Mathematical Programming Computation, 10 (1), 119-142, 2018. DOI:10.1007/s12532-017-0130-5