# grb-sys

[![grb-sys crate](https://img.shields.io/crates/v/grb-sys.svg)](https://crates.io/crates/grb-sys)

## Introduction

`grb-sys` is a crate for the [Rust][Rust] programming language
providing low-level access to the [Gurobi][Gurobi] optimization
suite.

The API bindings are automatically generated from the C header files
on your system.

## Author

Frank Fischer <frank-fischer@shadow-soft.de>

## License

Licensed under MIT.

## Build

Add the following line to your `Cargo.toml`.

    [dependencies]
    grb-sys = "^0.1"
    
If Gurobi is not installed to your system location (e.g. /usr or /usr/local),
the build script requires the environment variable `GUROBI_HOME` to be
set to the path of your Gurobi installation, e.g.

    export GUROBI_HOME=/opt/gurobi900/linux64
    
## Documentation

The [API reference][API] documentation.
    
## Remarks

The following versions of Gurobi and and `grb-sys` are known to work.

- `grb-sys` 0.1 and Gurobi 8.0
- `grb-sys` 0.1.2 and Gurobi 9.0

[Rust]: https://www.rust-lang.org
[Gurobi]:  https://www.gurobi.com
[API]: http://fifr.spdns.de/doc/gurobi_sys