Skip to content

Update README for public release #25

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
merged 1 commit into from
Feb 11, 2023
Merged

Update README for public release #25

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
9 changes: 4 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,16 @@ multi-objective optimization.

## Installation

This package is currently under development. You can install it as follows:
Install MOA using `Pkg.add`:

```julia
] add https://github.com/jump-dev/MultiObjectiveAlgorithms.jl
] add JuMP#od/vector-optimization
] add MultiObjectiveAlgorithms
```

## Usage with JuMP

**Compat: this requires at least JuMP v1.8.0**

Use `MultiObjectiveAlgorithms` with JuMP as follows:

```julia
Expand All @@ -30,8 +31,6 @@ set_optimizer_attribute(model, MOA.SolutionLimit(), 4)
Replace `HiGHS.Optimizer` with an optimizer capable of solving a
single-objective instance of your optimization problem.

You must set the `MOA.Algorithm` attribute to choose the solution algorithm.

You may set additional optimizer attributes, the supported attributes depend on
the choice of solution algorithm.

Expand Down