Skip to content

Commit c33fd58

Browse files
authored
Update Docs For ALAMO EXE Note (#1230)
* Update settings.rst * Update install_optional.rst * Update alamo.rst
1 parent a80a7f1 commit c33fd58

3 files changed

Lines changed: 12 additions & 2 deletions

File tree

docs/source/chapt_flowsheet/reference/settings.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,11 @@ Options in the **Settings, FOQUS** tab are described below.
7777
required to use the iREVEAL surrogate model module.
7878

7979
#. **ALAMO EXE** is the path to the ALAMO executable. This is required
80-
to use the ALAMO surrogate model module.
80+
to use the ALAMO surrogate model module. Some installations may have two
81+
executables; **alamo.exe** is the main executable for accessing the ALAMO
82+
trainer, and **alamo-ui.exe** is a second executable for launching the
83+
stand-alone user interface application. The **ALAMO EXE** path should be
84+
set as the path to the main executable.
8185

8286
#. **RScript Path** is the path to the RScript executable. This is
8387
required for surrogate model modules that use R as a platform.

docs/source/chapt_install/install_optional.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,8 @@ to the `ALAMO Home Page <https://sahinidis.coe.gatech.edu/alamo>`_.
7373
Download ALAMO and request a license from the `ALAMO download page
7474
<https://minlp.com/alamo-downloads>`_.
7575

76+
The path to the ALAMO executable will need to be set in the "Settings" panel. Some installations may have two executables; **alamo.exe** is the main executable for accessing the ALAMO trainer, and **alamo-ui.exe** is a second executable for launching the stand-alone user interface application. The **ALAMO EXE** path should be set as the path to the main executable.
77+
7678

7779
Install NLopt
7880
^^^^^^^^^^^^^

docs/source/chapt_surrogates/tutorial/alamo.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,11 @@ simulation model such as: Excel, Aspen plus, Aspen custom modeler, etc.
1414
Note: Before starting this tutorial the ALAMO product must be downloaded
1515
from the products page on the CCSI website. The path for the ALAMO
1616
executable file must be set in FOQUS settings (see Section
17-
:ref:`section.settings`).
17+
:ref:`section.settings`). Some installations may have two executables;
18+
**alamo.exe** is the main executable for accessing the ALAMO trainer,
19+
and **alamo-ui.exe** is a second executable for launching the stand-alone
20+
user interface application. The **ALAMO EXE** path should be set as the path
21+
to the main executable.
1822

1923
The FOQUS file (**Surrogate_Tutorial_1.foqus**),
2024
where Steps 1 to 42 of this tutorial have been completed

0 commit comments

Comments
 (0)