@@ -3,11 +3,30 @@ Installing Coek
3
3
4
4
There are several options for installing Coek:
5
5
6
+ * Installing with the top-level ``build_dev.sh `` script.
6
7
* Install the latest release or development branch using Spack
7
8
* Install from source using CMake
8
9
10
+ Installing with ``build_dev.sh ``
11
+ --------------------------------
12
+
9
13
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
11
30
12
31
Installing with Spack
13
32
---------------------
@@ -79,7 +98,7 @@ Similarly, you can see the packages installed with Spack with the *find* command
79
98
80
99
.. code-block :: bash
81
100
82
- spack find coek@dev
101
+ spack find
83
102
84
103
.. note ::
85
104
@@ -103,7 +122,9 @@ Coek includes a variety of configuration options that can be used to customize a
103
122
* - python
104
123
- Build pycoek and install coek python libraries
105
124
* - gurobi
106
- - Build with Gurobi optimization library
125
+ - Build with the Gurobi optimization library
126
+ * - highs
127
+ - Build with the Highs optimization library
107
128
* - cppad
108
129
- Build with the CppAD library
109
130
* - asl
@@ -185,7 +206,9 @@ are configured with the following CMake options:
185
206
* - with_python
186
207
- Build pycoek and install coek python libraries
187
208
* - 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
189
212
* - with_cppad
190
213
- Build with the CppAD library
191
214
* - with_asl
0 commit comments