Skip to content

Commit

Permalink
Prep for v1.0 (#188)
Browse files Browse the repository at this point in the history
  • Loading branch information
odow authored Feb 17, 2022
1 parent 5ee3d45 commit b2cd21f
Show file tree
Hide file tree
Showing 16 changed files with 50 additions and 781 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@ jobs:
strategy:
fail-fast: false
matrix:
version: ['1.0', '1'] # Test against LTS and current minor release
version: ['1.6', '1'] # Test against LTS and current minor release
os: [ubuntu-latest, macOS-latest, windows-latest]
arch: [x64]
include:
# Also test against 32-bit Linux on LTS.
- version: '1.0'
- version: '1.6'
os: ubuntu-latest
arch: x86
steps:
Expand Down
11 changes: 3 additions & 8 deletions Project.toml
Original file line number Diff line number Diff line change
@@ -1,22 +1,17 @@
name = "Cbc"
uuid = "9961bab8-2fa3-5c5a-9d89-47fab24efd76"
repo = "https://github.com/jump-dev/Cbc.jl.git"
version = "0.9.2"
version = "1.0.0"

[deps]
BinaryProvider = "b99e7846-7c00-51b0-8f62-c81ae34c0232"
CEnum = "fa961155-64e5-5f13-b03f-caf6b980ea82"
Cbc_jll = "38041ee0-ae04-5750-a4d2-bb4d0d83d27d"
Libdl = "8f399da3-3557-5675-b5ff-fb832c97cbdb"
MathOptInterface = "b8f27783-ece8-5eb3-8dc8-9495eed66fee"
SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"

[compat]
BinaryProvider = "0.5.9"
CEnum = "0.3, 0.4"
Cbc_jll = "=2.10.5, ~200.1000.500"
MathOptInterface = "0.10.6"
julia = "1"
MathOptInterface = "1"
julia = "1.6"

[extras]
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
Expand Down
36 changes: 4 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
[![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)

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

The wrapper has two components:
* a thin wrapper around the complete C API
Expand All @@ -23,9 +23,7 @@ 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.
install the Cbc binaries. (You do not need to install Cbc separately.)

## Use with JuMP

Expand Down Expand Up @@ -73,36 +71,10 @@ The following options are likely to be the most useful:
The complete list of parameters can be found by running the `cbc` executable and
typing `?` at the prompt.

On Julia 1.3 and above, you can start the `cbc` executable from Julia as follows:
You can start the `cbc` executable from Julia as follows:
```julia
using Cbc_jll
Cbc_jll.cbc() do exe
run(`$(exe)`)
end
```

## Custom Installation

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:
```julia
ENV["JULIA_CBC_LIBRARY_PATH"] = "/usr/local/Cellar/cbc/2.10.5/lib"
import Pkg
Pkg.add("Cbc")
Pkg.build("Cbc")
```
Replace `"/usr/local/Cellar/cbc/2.10.5/lib"` with a different path as
appropriate.

**You must have `JULIA_CBC_LIBRARY_PATH` set _every_ time you run `using Cbc`,
not just when you install it.**

Switch back to the default binaries as follows:
```julia
delete!(ENV, "JULIA_CBC_LIBRARY_PATH")
import Pkg
Pkg.build("Cbc")
```
4 changes: 0 additions & 4 deletions deps/.gitignore

This file was deleted.

66 changes: 0 additions & 66 deletions deps/build.jl

This file was deleted.

56 changes: 0 additions & 56 deletions deps/build_Cgl.v0.60.2.jl

This file was deleted.

Loading

0 comments on commit b2cd21f

Please sign in to comment.