Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Docs For ALAMO EXE Note #1230

Merged
merged 3 commits into from
Jul 3, 2024
Merged

Update Docs For ALAMO EXE Note #1230

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5762c00
Update settings.rst
bpaul4 Jul 3, 2024
4d8b64f
Update install_optional.rst
bpaul4 Jul 3, 2024
27c6fd4
Update alamo.rst
bpaul4 Jul 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/source/chapt_flowsheet/reference/settings.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,11 @@ Options in the **Settings, FOQUS** tab are described below.
required to use the iREVEAL surrogate model module.

#. **ALAMO EXE** is the path to the ALAMO executable. This is required
to use the ALAMO surrogate model module.
to use the ALAMO surrogate model module. 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.

#. **RScript Path** is the path to the RScript executable. This is
required for surrogate model modules that use R as a platform.
Expand Down
2 changes: 2 additions & 0 deletions docs/source/chapt_install/install_optional.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,8 @@ to the `ALAMO Home Page <https://sahinidis.coe.gatech.edu/alamo>`_.
Download ALAMO and request a license from the `ALAMO download page
<https://minlp.com/alamo-downloads>`_.

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.


Install NLopt
^^^^^^^^^^^^^
Expand Down
6 changes: 5 additions & 1 deletion docs/source/chapt_surrogates/tutorial/alamo.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,11 @@ simulation model such as: Excel, Aspen plus, Aspen custom modeler, etc.
Note: Before starting this tutorial the ALAMO product must be downloaded
from the products page on the CCSI website. The path for the ALAMO
executable file must be set in FOQUS settings (see Section
:ref:`section.settings`).
:ref:`section.settings`). 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.

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