From b778e7f668574dca1c821f2b47d83f86e5959255 Mon Sep 17 00:00:00 2001 From: Karlo Berket Date: Tue, 24 Sep 2024 13:22:32 -0700 Subject: [PATCH] update docs for SimSinter and TurbineLite configuration to clarify path locations (#1238) * docs for SimSinter and TurbineLite configuration provide most likely path * fixing code block * fixing spelling * fix extra quote --- docs/source/chapt_install/install_optional.rst | 12 +++--------- foqus_lib/framework/surrogate/ACOSSO.py | 2 +- foqus_lib/framework/surrogate/BSS-ANOVA.py | 2 +- 3 files changed, 5 insertions(+), 11 deletions(-) diff --git a/docs/source/chapt_install/install_optional.rst b/docs/source/chapt_install/install_optional.rst index 4b7d92491..aa669c933 100644 --- a/docs/source/chapt_install/install_optional.rst +++ b/docs/source/chapt_install/install_optional.rst @@ -56,12 +56,12 @@ Install Turbine and SimSinter (Windows Only) * SimSinter 1. In "Settings" (see Figure 1 below) go to the "FOQUS" tab - 2. Modify the "SimSinter Home" field to point to the directory you installed SimSinter + 2. Modify the "SimSinter Home" field to point to the directory you installed SimSinter. For installations of SimSinter 3.x or higher this will most likely be ``C:\Program Files\CCSI\SimSinter``. For older versions of SimSinter this will most likely be ``C:\Program Files (x86)\CCSI\SimSinter`` * TurbineLite 1. In "Settings" (see Figure 1 below) go to the "Turbine" tab - 2. In the "TurbineLite (local)" section modify the "TurbineLite Home" field to point to the directory you installed TurbineLite + 2. In the "TurbineLite (local)" section modify the "TurbineLite Home" field to point to the directory you installed TurbineLite. For installations of TurbineLite 3.x or higher this will most likely be ``C:\Program Files\Turbine\Lite``. For older versions of SimSinter this will most likely be ``C:\Program Files (x86)\Turbine\Lite`` Install ALAMO ^^^^^^^^^^^^^ @@ -149,10 +149,4 @@ ACOSSO and BSS-ANOVA surrogate models and the Basic Data's SolventFit model. The FOQUS "Settings" Tab ------------------------ -Use the FOQUS "Settings" tab to set the optional software configuration described in this section: - -.. figure:: ./figs/foqus-settings.png - :alt: Figure 1: The FOQUS "Settings" tab - :name: fig.settings - - Figure 1: The FOQUS "Settings" tab +Use the FOQUS "Settings" tab to set the optional software configuration described in this section. diff --git a/foqus_lib/framework/surrogate/ACOSSO.py b/foqus_lib/framework/surrogate/ACOSSO.py index 8ff1137a7..7809f963b 100644 --- a/foqus_lib/framework/surrogate/ACOSSO.py +++ b/foqus_lib/framework/surrogate/ACOSSO.py @@ -18,7 +18,7 @@ beginning of the file (see pluginSearch.plugins() for exact character count of text). They also need to have a .py extension and inherit the surrogate class. -* Plugin wprapper for the ACOSSO surrogate model builer. +* Plugin wprapper for the ACOSSO surrogate model builder. * ACOSSO is executed in R and a working R install with the quadprog package is required. The user must install R * ACOSSO Ref: diff --git a/foqus_lib/framework/surrogate/BSS-ANOVA.py b/foqus_lib/framework/surrogate/BSS-ANOVA.py index e679c6a83..956f7bccd 100644 --- a/foqus_lib/framework/surrogate/BSS-ANOVA.py +++ b/foqus_lib/framework/surrogate/BSS-ANOVA.py @@ -18,7 +18,7 @@ beginning of the file (see pluginSearch.plugins() for exact character count of text). They also need to have a .py extension and inherit the surrogate class. -* Plugin wrapper for the BSS-ANOVA surrogate model builer. +* Plugin wrapper for the BSS-ANOVA surrogate model builder. * BSS-ANOVA is executed in R and a working R install with the quadprog package is required. The user must install R * BSS-ANOVA Ref: