Updating documentation so PSUADE is not optional software (#1264)

* moving psuade-lite installation instructions from optional software to required steps when installing FOQUS

* fixing typo

* trying to match black versions

* fixing typo in word 'incriment'. Replacing with 'increment'

---------

Co-authored-by: Keith Beattie <ksbeattie@lbl.gov>

Author: sotorrio1

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/psf/black
-    rev: 22.3.0
+    rev: 24.3.0
     hooks:
     - id: black
       language_version: python3

docs/source/chapt_install/index.rst

@@ -23,9 +23,8 @@ FOQUS:
       conda create --name ccsi-foqus -c conda-forge python=3.10 pywin32=306
       conda activate ccsi-foqus
       pip install ccsi-foqus
+      conda install --yes -c conda-forge -c CCSI-Toolset psuade-lite=1.9  # Install psuade-lite
       foqus --make-shortcut  # Create Desktop shortcut (Windows only)
-
-  - 
   
   - In a terminal, to run::
       
@@ -44,6 +43,7 @@ Contents
 
     install_python
     install_foqus
+    install_psuade
     install_examples
     run_foqus
     install_optional

docs/source/chapt_install/install_optional.rst

@@ -10,22 +10,6 @@ Windows and is used to interface with Excel, Aspen, and gPROMS software.
 
 Other software listed below will enable additional features of FOQUS if available.
 
-Install PSUADE-Lite (current version: 1.9.0)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-PSUADE (Problem Solving environment for Uncertainty Analysis and Design Exploration) is a software
-toolkit containing a rich set of tools for performing uncertainty analysis, global sensitivity
-analysis, design optimization, model calibration, and more.
-
-`PSUADE-Lite <https://github.com/LLNL/psuade-lite>`_ is now available as a Conda package. To install just follow the steps below::
-
-  conda activate ccsi-foqus
-  conda install --yes -c conda-forge -c CCSI-Toolset psuade-lite=1.9
-  psuade --help  # quickly test that the psuade executable has been installed correctly
-
-The ``psuade`` executable should now be available within the Conda environment's folders, i.e. at the path ``$CONDA_PREFIX/bin/psuade`` (Linux, macOS) or ``%CONDA_PREFIX%\bin\psuade.exe`` (Windows).
-Once you set the full path in the corresponding field in the FOQUS GUI "Settings" tab, you should be able to use it normally within FOQUS.
-
 Install Turbine and SimSinter (Windows Only)
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 .. note::

docs/source/chapt_install/install_psuade.rst

@@ -0,0 +1,17 @@
+.. _install_psuade:
+
+Install PSUADE-Lite (current version: 1.9.0)
+--------------------------------------------
+
+PSUADE (Problem Solving environment for Uncertainty Analysis and Design Exploration) is a software
+toolkit containing a rich set of tools for performing uncertainty analysis, global sensitivity
+analysis, design optimization, model calibration, and more.
+
+`PSUADE-Lite <https://github.com/LLNL/psuade-lite>`_ is now available as a Conda package. To install just follow the steps below::
+
+  conda activate ccsi-foqus
+  conda install --yes -c conda-forge -c CCSI-Toolset psuade-lite=1.9
+  psuade --help  # quickly test that the psuade executable has been installed correctly
+
+The ``psuade`` executable should now be available within the Conda environment's folders, i.e. at the path ``$CONDA_PREFIX/bin/psuade`` (Linux, macOS) or ``%CONDA_PREFIX%\bin\psuade.exe`` (Windows).
+Once you set the full path in the corresponding field in the FOQUS GUI "Settings" tab, you should be able to use it normally within FOQUS.

foqus_lib/framework/optimizer/BFGS.py

@@ -201,7 +201,7 @@ def optimize(self):
         saveRes = self.options["Save results"].value
         setName = self.options["Set Name"].value
         if saveRes:
-            setName = self.dat.flowsheet.results.incrimentSetName(setName)
+            setName = self.dat.flowsheet.results.incrementSetName(setName)
         start = time.time()
         self.userInterupt = False
         self.bestSoFar = float("inf")

foqus_lib/framework/optimizer/NLopt.py

@@ -362,7 +362,7 @@ def optimize(self):
 
         # The set name to use when saving evaluations in flowsheet results
         if saveRes:
-            setName = self.dat.flowsheet.results.incrimentSetName(setName)
+            setName = self.dat.flowsheet.results.incrementSetName(setName)
         #
         # Create optimization object and set options
         opt = nlopt.opt(method, n)

foqus_lib/framework/optimizer/OptCMA.py

@@ -256,7 +256,7 @@ def optimize(self):
         tolstagnation = self.options["tolstagnation"].value
         objRecFile = self.options["Log Objective"].value
         # Increment set name it already used
-        setName = self.dat.flowsheet.results.incrimentSetName(setName)
+        setName = self.dat.flowsheet.results.incrementSetName(setName)
         #
         # Some of these options get passed to the CMA-ES solver so set
         # up options dict for that

foqus_lib/framework/optimizer/PSUADE.py

@@ -124,7 +124,7 @@ def optimize(self):
         tol = self.options["tol"].value
         setName = self.options["Results name"].value
         # Increment set name if already used
-        setName = self.dat.flowsheet.results.incrimentSetName(setName)
+        setName = self.dat.flowsheet.results.incrementSetName(setName)
         #
         # Options are all read in so now initialize things
         #

foqus_lib/framework/optimizer/SLSQP.py

@@ -198,7 +198,7 @@ def optimize(self):
         saveRes = self.options["Save results"].value
         setName = self.options["Set Name"].value
         if saveRes:
-            setName = self.dat.flowsheet.results.incrimentSetName(setName)
+            setName = self.dat.flowsheet.results.incrementSetName(setName)
         start = time.time()
         self.userInterupt = False
         self.bestSoFar = float("inf")

foqus_lib/framework/optimizer/SM_Optimizer.py

@@ -318,7 +318,7 @@ def optimize(self):
         # The set name to use when saving evaluations in flowsheet results
         # (to get unique set names in flowsheet results section)
         if Saveresults:
-            setName = self.dat.flowsheet.results.incrimentSetName(SetName)
+            setName = self.dat.flowsheet.results.incrementSetName(SetName)
 
         # The solver is all setup and ready to go
         start = time.time()  # get start time