Skip to content

Commit

Permalink
version bump and docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanjoneil committed Jan 8, 2017
1 parent 7a6709b commit e3e87e1
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 3 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Ruby Algebraic Modeling System

RAMS is a library for formulating and solving [Mixed Integer Linear Programs](https://en.wikipedia.org/wiki/Integer_programming) in Ruby. Currently, it only supports the [GNU Linear Programming Kit](https://www.gnu.org/software/glpk/), but more solvers are on the way.
RAMS is a library for formulating and solving [Mixed Integer Linear Programs](https://en.wikipedia.org/wiki/Integer_programming) in Ruby. Currently it supports [CLP](https://www.coin-or.org/Clp/), [CBC](https://www.coin-or.org/Cbc/), and [GNU Linear Programming Kit](https://www.gnu.org/software/glpk/), and more solvers are on the way.

## Quick Start

Make sure you have `glpsol` available on your system. On OSX you can do that with `brew`:
GLPK is the default solver, so make sure you at least have `glpsol` available on your system. On OSX you can do that with `brew`:

```
brew install glpk
Expand Down Expand Up @@ -51,4 +51,17 @@ x2 = 0.0
x3 = 1.0
```

If you want to switch to a different solver, simply install that solver onto your system, and change the `solver` attribute on the model.

```ruby
m.solver = :cbc # or...
m.solver = :clp
```

Additional solver arguments can be passed as though they are command line flags.

```ruby
m.args = ['--dfs', '--bib']
```

More examples are available [here](https://github.com/ryanjoneil/rams/tree/master/examples). Happy modeling!
2 changes: 1 addition & 1 deletion rams.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)

Gem::Specification.new do |spec|
spec.name = 'rams'
spec.version = '0.1'
spec.version = '0.1.1'
spec.authors = ["Ryan J. O'Neil"]
spec.email = ['ryanjoneil@gmail.com']
spec.summary = 'Ruby Algebraic Modeling System'
Expand Down

0 comments on commit e3e87e1

Please sign in to comment.