Skip to content

Various updates to README #181

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
odow merged 1 commit into from
Nov 9, 2021
Merged

Various updates to README #181

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 19 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,38 +1,37 @@
# COIN-OR Branch and Cut Interface (Cbc.jl)

[![](https://www.coin-or.org/wordpress/wp-content/uploads/2014/08/COINOR.png)](https://www.coin-or.org)

`Cbc.jl` is an interface to the **[COIN-OR Branch and Cut](https://projects.coin-or.org/Cbc)**
solver. It provides a complete interface to the low-level C API, as well as an
implementation of the solver-independent `MathOptInterface`
API's

*Note: This wrapper is maintained by the JuMP community and is not a COIN-OR
project.*
# Cbc.jl

[![Build Status](https://github.com/jump-dev/Cbc.jl/workflows/CI/badge.svg?branch=master)](https://github.com/jump-dev/Cbc.jl/actions?query=workflow%3ACI)
[![codecov](https://codecov.io/gh/jump-dev/Cbc.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/jump-dev/Cbc.jl)

## Installation
`Cbc.jl` is a Julia wrapper for the [COIN-OR Branch and Cut (Cbc)](https://projects.coin-or.org/Cbc)
solver.

The package can be installed with `Pkg.add`.
The wrapper has two components:
* a thin wrapper around the complete C API
* an interface to [MathOptInterface](https://github.com/jump-dev/MathOptInterface)

*Note: This wrapper is maintained by the JuMP community and is not a COIN-OR
project.*

## Installation

Install Cbc.jl using `Pkg.add`:
```julia
import Pkg
Pkg.add("Cbc")
import Pkg; Pkg.add("Cbc")
```

In addition to installing the Cbc.jl package, this will also download and
install the Cbc binaries. (You do not need to install Cbc separately.) If you
require a custom build of Cbc, see the **Custom Installation** instructions
below.

## Using with JuMP
## Use with JuMP

Use `Cbc.Optimizer` to use Cbc with [JuMP](https://github.com/jump-dev/JuMP.jl):
To use Cbc with [JuMP](https://github.com/jump-dev/JuMP.jl), use `Cbc.Optimizer`:
```julia
using Cbc
using JuMP
using JuMP, Cbc
model = Model(Cbc.Optimizer)
set_optimizer_attribute(model, "logLevel", 1)
```
Expand Down Expand Up @@ -86,8 +85,9 @@ end

To install custom built Cbc binaries, use the environmental variable
`JULIA_CBC_LIBRARY_PATH` to point to the path at which you installed Cbc (the
folder containing `libCbcSolver`). For example, on Mac, after installing Cbc
with `brew install cbc`, use:
folder containing `libCbcSolver`).

For example, on Mac, after installing Cbc with `brew install cbc`, use:
```julia
ENV["JULIA_CBC_LIBRARY_PATH"] = "/usr/local/Cellar/cbc/2.10.5/lib"
import Pkg
Expand Down