diff --git a/README.md b/README.md index 3e3259d..b82e1f5 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ # DisjunctiveProgramming.jl -Generalized Disjunctive Programming (GDP) extension to JuMP, based on the GDP modeling paradigm described in [Perez and Grossmann, 2023](https://arxiv.org/abs/2303.04375). -![](logo.png) +A Generalized Disjunctive Programming (GDP) extension to JuMP. + +![logo](logo.png) [![codecov](https://codecov.io/gh/hdavid16/DisjunctiveProgramming.jl/graph/badge.svg?token=3FRPGMWF0J)](https://codecov.io/gh/hdavid16/DisjunctiveProgramming.jl) [![Docs](https://img.shields.io/badge/docs-stable-blue.svg)](https://hdavid16.github.io/DisjunctiveProgramming.jl/stable/) @@ -14,6 +15,14 @@ using Pkg Pkg.add("DisjunctiveProgramming") ``` +## Reference + +The theory behind the GDP modeling paradigm is described in the following references: + +- [Perez and Grossmann, 2023](https://arxiv.org/abs/2303.04375) +- [Generalized Disjunctive Programming](https://optimization.cbe.cornell.edu/index.php?title=Convex_generalized_disjunctive_programming_(GDP)) +- [Disjunctive Inequalities](https://optimization.cbe.cornell.edu/index.php?title=Disjunctive_inequalities) + ## Model A generalized disjunctive programming (GDP) model is created using `GDPModel()`, where the optimizer can be passed at model creation, along with other keyword arguments supported by JuMP Models. @@ -223,5 +232,6 @@ print(m) ``` ## Contributing + `DisjunctiveProgramming` is being actively developed and suggestions or other forms of contribution are encouraged. There are many ways to contribute to this package. Feel free to create an issue to address questions or provide feedback. diff --git a/docs/src/index.md b/docs/src/index.md index 73591dc..1923f7e 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -1,7 +1,8 @@ # DisjunctiveProgramming.jl -Generalized Disjunctive Programming (GDP) extension to JuMP, based on the GDP modeling paradigm described in [Perez and Grossmann, 2023](https://arxiv.org/abs/2303.04375). -![](assets/logo.png) +A Generalized Disjunctive Programming (GDP) extension to JuMP. + +![logo](assets/logo.png) [![codecov](https://codecov.io/gh/hdavid16/DisjunctiveProgramming.jl/graph/badge.svg?token=3FRPGMWF0J)](https://codecov.io/gh/hdavid16/DisjunctiveProgramming.jl) [![Docs](https://img.shields.io/badge/docs-stable-blue.svg)](https://hdavid16.github.io/InventoryManagement.jl/stable/) @@ -14,6 +15,14 @@ using Pkg Pkg.add("DisjunctiveProgramming") ``` +## Reference + +The theory behind the GDP modeling paradigm is described in the following references: + +- [Perez and Grossmann, 2023](https://arxiv.org/abs/2303.04375) +- [Generalized Disjunctive Programming](https://optimization.cbe.cornell.edu/index.php?title=Convex_generalized_disjunctive_programming_(GDP)) +- [Disjunctive Inequalities](https://optimization.cbe.cornell.edu/index.php?title=Disjunctive_inequalities) + ## Model A generalized disjunctive programming (GDP) model is created using [`GDPModel`](@ref), where the optimizer can be passed at model creation, along with other keyword arguments supported by JuMP Models. @@ -218,5 +227,6 @@ print(m) ``` ## Contributing + `DisjunctiveProgramming` is being actively developed and suggestions or other forms of contribution are encouraged. -There are many ways to contribute to this package. Feel free to create an issue to address questions or provide feedback. \ No newline at end of file +There are many ways to contribute to this package. Feel free to create an issue to address questions or provide feedback.