From 62ac84bb1943e40b7e7c94247b72f330e94f744a Mon Sep 17 00:00:00 2001 From: Balasubramanian Narasimhan Date: Wed, 31 Jan 2024 15:29:09 -0800 Subject: [PATCH] Update Readme URLs --- README.Rmd | 2 +- README.md | 50 ++++++++++++++++++++++++++++---------------------- 2 files changed, 29 insertions(+), 23 deletions(-) diff --git a/README.Rmd b/README.Rmd index af55cd3f..21264a00 100755 --- a/README.Rmd +++ b/README.Rmd @@ -28,7 +28,7 @@ CVXR includes several open source solvers in addition to the default OSQP, ECOS and SCS. Recent (1.x+) versions also include support for commercial solvers such as [MOSEK](https://www.mosek.com), [GUROBI](https://www.gurobi.com) and -[CPLEX](https://www.ibm.com/analytics/cplex-optimizer). +[CPLEX](https://www.ibm.com/products/ilog-cplex-optimization-studio/cplex-optimizer). For details and examples, we refer you to [Fu, Narasimhan, Boyd](https://dx.doi.org/10.18637/jss.v094.i14) (2020). If you use diff --git a/README.md b/README.md index 28e2d994..8647e0a9 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,11 @@ +--- +output: github_document +--- # CVXR - -[![R build -status](https://github.com/cvxgrp/CVXR/workflows/R-CMD-check/badge.svg)](https://github.com/cvxgrp/CVXR/actions) +[![R build status](https://github.com/cvxgrp/CVXR/workflows/R-CMD-check/badge.svg)](https://github.com/cvxgrp/CVXR/actions) [![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/CVXR)](https://cran.r-project.org/package=CVXR) [![](https://cranlogs.r-pkg.org/badges/CVXR)](https://CRAN.R-project.org/package=CVXR) @@ -12,44 +13,47 @@ CVXR provides an object-oriented modeling language for convex optimization, similar to `CVX`, `CVXPY`, `YALMIP`, and `Convex.jl`. It allows the user to formulate convex optimization problems in a natural mathematical syntax rather than the restrictive standard form required -by most solvers. The user specifies an objective and set of constraints -by combining constants, variables, and parameters using a library of -functions with known mathematical properties. `CVXR` then applies signed -[disciplined convex programming +by most solvers. The user specifies an objective and set of +constraints by combining constants, variables, and parameters using a +library of functions with known mathematical properties. `CVXR` then +applies signed [disciplined convex programming (DCP)](https://web.stanford.edu/~boyd/papers/pdf/disc_cvx_prog.pdf) to -verify the problem’s convexity. Once verified, the problem is converted -into standard conic form using graph implementations and passed to a -cone solver such as [ECOS](https://github.com/embotech/ecos) or +verify the problem’s convexity. Once verified, the problem is +converted into standard conic form using graph implementations and +passed to a cone solver such as +[ECOS](https://github.com/embotech/ecos) or [SCS](https://github.com/cvxgrp/scs). CVXR includes several open source solvers in addition to the default OSQP, ECOS and SCS. Recent (1.x+) versions also include support for commercial solvers such as [MOSEK](https://www.mosek.com), [GUROBI](https://www.gurobi.com) and -[CPLEX](https://www.ibm.com/analytics/cplex-optimizer). +[CPLEX](https://www.ibm.com/products/ilog-cplex-optimization-studio/cplex-optimizer). For details and examples, we refer you to [Fu, Narasimhan, -Boyd](https://dx.doi.org/10.18637/jss.v094.i14) (2020). If you use CVXR -in your work, please cite this reference. (The R command -`citation("CVXR", bibtex = TRUE)` will also give you a bibtex-formatted -entry.) +Boyd](https://dx.doi.org/10.18637/jss.v094.i14) (2020). If you use +CVXR in your work, please cite this reference. (The R command +`citation("CVXR", bibtex = TRUE)` will also give you a +bibtex-formatted entry.) ## Installation This package is now released on CRAN, so you can install the current -released version as you would any other package for R, version 3.4 and -higher. (`CVXR` is known to work with earlier versions of R too, but we -don’t check our releases against older versions of R.) +released version as you would any other package for R, version 3.4 +and higher. (`CVXR` is known to work with earlier versions of R too, +but we don't check our releases against older versions of R.) + -``` r +```r install.packages('CVXR', repos = "https://CRAN.R-project.org") ``` Development versions can be installed from the Github repository -assuming you have the development tools for R available, including the C -compilers etc. Execute: +assuming you have the development tools +for R available, including the C compilers etc. Execute: + -``` r +```r library(devtools) install_github("cvxgrp/CVXR") ``` @@ -59,3 +63,5 @@ install_github("cvxgrp/CVXR") A number of tutorial examples are available on the [CVXR website](https://cvxr.rbind.io) along with links to our useR! 2019 short-course. + +