Adding documentation for Aspen Configuration Panel (#1243)

* Adding documentation about Aspen Configuration Panel * Updating default path * Updating default path in documentation
CCSI-Toolset · Oct 1, 2024 · 2e54f98 · 2e54f98
1 parent 0db11e9
commit 2e54f98
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 8 deletions.
diff --git a/docs/source/chapt_flowsheet/figs/nodeEditor_AspenConfig.png b/docs/source/chapt_flowsheet/figs/nodeEditor_AspenConfig.png
diff --git a/docs/source/chapt_flowsheet/reference/flowsheet.rst b/docs/source/chapt_flowsheet/reference/flowsheet.rst
@@ -268,6 +268,28 @@ contains the columns: Name, Value, Unit, Type, Description, and Tags.
 The value of the outputs may not correspond to the inputs until the
 simulation has been run.
 
+Aspen Configuration Parameters
+------------------------------
+
+Users can modify some Aspen Consumer configuration parameters in the Node Editor panel. They can
+browse to the location of the AspenSinterConsumerConsole.xml file using the **Browse...** button.
+For installations of SimSinter 3.x or higher this will most likely be
+``C:\Program Files\Turbine\Lite\Consumers``. For older versions of SimSinter this will most likely be
+``C:\Program Files (x86)\Turbine\Lite\Consumers``.
+
+Once the correct XML file has been selected, the table will be populated with the current values for
+**TimeOutIterations**, **TimeOutSetupIterations** and **TimePostInitIterations**.
+
+Users can edit any of these three values and when they are ready click the **Update Configuration
+Parameters** button. The current XML file will get updated with the new values and a backup copy
+of the old version will get saved in the same location.
+
+.. figure:: ../figs/nodeEditor_AspenConfig.png
+   :alt: Aspen Configuration Parameters
+   :name: fig.node.editor.aspen.config.parameters
+
+   Aspen Configuration Parameters
+
 Node Script
 -----------
 

diff --git a/foqus_lib/gui/flowsheet/nodePanel_UI.ui b/foqus_lib/gui/flowsheet/nodePanel_UI.ui
@@ -6,7 +6,7 @@
    <rect>
     <x>0</x>
     <y>0</y>
-    <width>3440</width>
+    <width>2560</width>
     <height>1387</height>
    </rect>
   </property>
@@ -441,14 +441,14 @@
         <item>
          <widget class="QToolBox" name="toolBox">
           <property name="currentIndex">
-           <number>0</number>
+           <number>3</number>
           </property>
           <widget class="QWidget" name="page">
            <property name="geometry">
             <rect>
              <x>0</x>
              <y>0</y>
-             <width>3370</width>
+             <width>2490</width>
              <height>367</height>
             </rect>
            </property>
@@ -749,7 +749,7 @@
             <rect>
              <x>0</x>
              <y>0</y>
-             <width>3370</width>
+             <width>2490</width>
              <height>367</height>
             </rect>
            </property>
@@ -924,8 +924,8 @@
             <rect>
              <x>0</x>
              <y>0</y>
-             <width>3370</width>
-             <height>879</height>
+             <width>2490</width>
+             <height>367</height>
             </rect>
            </property>
            <attribute name="label">
@@ -958,7 +958,7 @@
             <rect>
              <x>0</x>
              <y>0</y>
-             <width>3370</width>
+             <width>2490</width>
              <height>367</height>
             </rect>
            </property>
@@ -978,7 +978,7 @@
               <item>
                <widget class="QLineEdit" name="configFile_edit">
                 <property name="text">
-                 <string>\Program Files (x86)\Turbine\Lite\Consumers\AspenSinterConsumerConsole.xml</string>
+                 <string>C:\Program Files\Turbine\Lite\Consumers\AspenSinterConsumerConsole.xml</string>
                 </property>
                </widget>
               </item>