Skip to content

Commit 98c42a4

Browse files
author
aritrasep
committed
v1.0
0 parents  commit 98c42a4

18 files changed

+2996
-0
lines changed

.gitignore

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
docs/build/
2+
docs/site/
3+
*.jl.cov
4+
*.jl.*.cov
5+
*.jl.mem

.travis.yml

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
language: julia
2+
os:
3+
- linux
4+
- osx
5+
julia:
6+
- 0.6
7+
notifications:
8+
email: false
9+
git:
10+
depth: 99999999
11+
matrix:
12+
allow_failures:
13+
- julia: 0.6
14+
## uncomment the following lines to override the default test script
15+
#script:
16+
# - julia -e 'Pkg.clone(pwd()); Pkg.build("Modof"); Pkg.test("Modof"; coverage=true)'
17+
after_success:
18+
- julia -e 'Pkg.add("Documenter")'
19+
- julia -e 'cd(Pkg.dir("Modof.jl")); include(joinpath("docs", "make.jl"))'

LICENSE

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
###############################################################################
2+
# #
3+
# This file is part of the julia module for Multi Objective Optimization #
4+
# (c) Copyright 2017 by Aritra Pal #
5+
# #
6+
# Permission is hereby granted, free of charge, to any person obtaining a #
7+
# copy of this software and associated documentation files (the "Software"), #
8+
# to deal in the Software without restriction, including without limitation #
9+
# the rights to use, copy, modify, merge, publish, distribute, sublicense, #
10+
# and/or sell copies of the Software, and to permit persons to whom the #
11+
# Software is furnished to do so, subject to the following conditions: #
12+
# #
13+
# The above copyright notice and this permission notice shall be included in #
14+
# all copies or substantial portions of the Software. #
15+
# #
16+
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR #
17+
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, #
18+
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE #
19+
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER #
20+
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING #
21+
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER #
22+
# DEALINGS IN THE SOFTWARE. #
23+
# #
24+
# Every publication and presentation for which work based on the Program or #
25+
# its output has been used must contain an appropriate citation and #
26+
# acknowledgment of the author(s) of the Program. #
27+
###############################################################################

REQUIRE

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
julia 0.6
2+
JuMP
3+
MathProgBase
4+
GLPK
5+
GLPKMathProgInterface
6+
Match

Readme.md

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Multiobjective Discrete Optimization Framework in Julia #
2+
3+
**Build Status:**
4+
[![Build Status](https://travis-ci.org/aritrasep/Modof.jl.svg?branch=master)](https://travis-ci.org/aritrasep/Modof.jl)
5+
6+
**Documentation:**
7+
[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://aritrasep.github.io/Modof.jl/docs/build/)
8+
9+
**DOI:**
10+
[![DOI](https://zenodo.org/badge/84245385.svg)](https://zenodo.org/badge/latestdoi/84245385)
11+
12+
`Modof.jl` is a framework used for solving multiobjective mixed integer programs in Julia. It has functions for
13+
1. Selecting, sorting, writing and normalizing a nondominated frontier
14+
2. Computing ideal and nadir points of a nondominated frontier
15+
3. Computing the closest and the farthest point from the ideal and the nadir points respectively.
16+
4. Computing the quality of a nondominated frontier:
17+
1. Exact (for biobjective and triobjective) and approximate (for more than 4 objectives) hypervolumes
18+
2. Cardinality
19+
3. Maximum and average coverage
20+
4. Uniformity
21+
5. Plotting nondominated frontiers of:
22+
1. Biobjective discrete and mixed problems
23+
2. Triobjective discrete problems
24+
6. Wrappers for the following algorithms in linux:
25+
1. [MDLS](http://prolog.univie.ac.at/research/MDLS/mdls_code.tar.gz) for solving multidimensional knapsack and biobjective set packing problems
26+
2. [NSGA-II](http://www.iitk.ac.in/kangal/codes/nsga2/nsga2-gnuplot-v1.1.6.tar.gz) for solving biobjective binary programs
27+
28+
**Note:** Functionalities corresponding to computing quality of a nondominated frontier and plotting nondominated frontiers have been moved to [pyModofSup.jl](https://github.com/aritrasep/pyModofSup.jl)
29+
30+
## Dependencies: ##
31+
32+
1. [Julia v0.6.0](https://julialang.org/downloads/)
33+
34+
## Installation ##
35+
36+
Once, Julia v0.6.0 has been properly installed, the following instructions in a **Julia** terminal will install **Modof.jl** on the local machine:
37+
38+
```julia
39+
Pkg.clone("https://github.com/aritrasep/Modof.jl")
40+
Pkg.build("Modof")
41+
```
42+
43+
In case `Pkg.build("Modof")` gives you an error on Linux, you may need to install the GMP library headers. For example, on Ubuntu/Debian and similar, give the following command from a terminal:
44+
45+
```
46+
$ sudo apt-get install libgmp-dev
47+
```
48+
49+
After that, restart the installation of the package with:
50+
51+
```
52+
Pkg.build("Modof")
53+
```
54+
55+
## Supporting and Citing: ##
56+
57+
The software in this ecosystem was developed as part of academic research. If you would like to help support it, please star the repository as such metrics may help us secure funding in the future. If you use [Modof.jl](https://github.com/aritrasep/Modof.jl), [Modolib.jl](https://github.com/aritrasep/Modolib.jl), [FPBH.jl](https://github.com/aritrasep/FPBH.jl), [FPBHCPLEX.jl](https://github.com/aritrasep/FPBHCPLEX.jl) or [pyModofSup.jl](https://github.com/aritrasep/pyModofSup.jl) software as part of your research, teaching, or other activities, we would be grateful if you could cite:
58+
59+
1. [Pal, A. and Charkhgard, H., A Feasibility Pump and Local Search Based Heuristic for Bi-objective Pure Integer Linear Programming](http://www.optimization-online.org/DB_FILE/2017/03/5902.pdf).
60+
2. [Pal, A. and Charkhgard, H., FPBH.jl: A Feasibility Pump based Heuristic for Multi-objective Mixed Integer Linear Programming in Julia](http://www.optimization-online.org/DB_FILE/2017/09/6195.pdf)
61+
62+
## Contributions ##
63+
64+
This package is written and maintained by [Aritra Pal](https://github.com/aritrasep). Please fork and send a pull request or create a [GitHub issue](https://github.com/aritrasep/Modof.jl/issues) for bug reports or feature requests.

0 commit comments

Comments
 (0)