Skip to content

Commit 81831be

Browse files
committed
Updating installation documentation
1 parent eea0d02 commit 81831be

File tree

2 files changed

+29
-5
lines changed

2 files changed

+29
-5
lines changed

Diff for: lib/coek/doc/install.rst

+27-4
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,30 @@ Installing Coek
33

44
There are several options for installing Coek:
55

6+
* Installing with the top-level ``build_dev.sh`` script.
67
* Install the latest release or development branch using Spack
78
* Install from source using CMake
89

10+
Installing with ``build_dev.sh``
11+
--------------------------------
12+
913
Developers will find the top-level ``build_dev.sh`` script useful for setting up a
10-
build environment after cloning the Coek repository.
14+
build environment after cloning the Coek repository. Thus, Coek can be installed as follows:
15+
16+
.. code-block:: bash
17+
18+
git clone [email protected]:sandialabs/coek.git
19+
./build_dev.sh
20+
21+
This script combines many elements of the detailed installation procedures documented below:
22+
23+
* Dependent packages are installed using Spack into the ``spack`` directory
24+
25+
* Coek is configured to build with Gurobi if the ``GUROBI_HOME`` environment variable is specified
26+
27+
* Coek is configured to build with Highs and Ipopt. Ipopt is dynamically linked at runtime.
28+
29+
* Coek is built within the ``build`` directory
1130

1231
Installing with Spack
1332
---------------------
@@ -79,7 +98,7 @@ Similarly, you can see the packages installed with Spack with the *find* command
7998

8099
.. code-block:: bash
81100
82-
spack find coek@dev
101+
spack find
83102
84103
.. note::
85104

@@ -103,7 +122,9 @@ Coek includes a variety of configuration options that can be used to customize a
103122
* - python
104123
- Build pycoek and install coek python libraries
105124
* - gurobi
106-
- Build with Gurobi optimization library
125+
- Build with the Gurobi optimization library
126+
* - highs
127+
- Build with the Highs optimization library
107128
* - cppad
108129
- Build with the CppAD library
109130
* - asl
@@ -185,7 +206,9 @@ are configured with the following CMake options:
185206
* - with_python
186207
- Build pycoek and install coek python libraries
187208
* - with_gurobi
188-
- Build with Gurobi optimization library
209+
- Build with the Gurobi optimization library
210+
* - with_highs
211+
- Build with the Highs optimization library
189212
* - with_cppad
190213
- Build with the CppAD library
191214
* - with_asl

Diff for: lib/coek/doc/overview.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ Capabilities
3838
* Solvers
3939

4040
* Ipopt - Coek can dynamically load the Ipopt C interface.
41-
* Gurobi - Coek links with the Gurobi C++ interface
41+
* Gurobi - Coek compiles with the Gurobi C++ interface
42+
* Highs - Coek compiles with the Highs C++ interface
4243

4344
* Automatic Differentiation
4445

0 commit comments

Comments
 (0)