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

Adding documentation for Aspen Configuration Panel #1243

Merged
merged 6 commits into from
Oct 1, 2024
Merged

Adding documentation for Aspen Configuration Panel #1243

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
64220ec
Adding documentation about Aspen Configuration Panel
sotorrio1 Sep 24, 2024
074434b
Merge remote-tracking branch 'origin/issue-1199' into issue-1199
sotorrio1 Sep 24, 2024
dfdacad
Merge branch 'master' into issue-1199
sotorrio1 Sep 24, 2024
1ae00bd
Updating default path
sotorrio1 Sep 24, 2024
e5c298a
Merge remote-tracking branch 'origin/issue-1199' into issue-1199
sotorrio1 Sep 24, 2024
8f505da
Updating default path in documentation
sotorrio1 Sep 24, 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
Binary file added docs/source/chapt_flowsheet/figs/nodeEditor_AspenConfig.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 22 additions & 0 deletions docs/source/chapt_flowsheet/reference/flowsheet.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------

Expand Down
16 changes: 8 additions & 8 deletions foqus_lib/gui/flowsheet/nodePanel_UI.ui
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<rect>
<x>0</x>
<y>0</y>
<width>3440</width>
<width>2560</width>
<height>1387</height>
</rect>
</property>
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -749,7 +749,7 @@
<rect>
<x>0</x>
<y>0</y>
<width>3370</width>
<width>2490</width>
<height>367</height>
</rect>
</property>
Expand Down Expand Up @@ -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">
Expand Down Expand Up @@ -958,7 +958,7 @@
<rect>
<x>0</x>
<y>0</y>
<width>3370</width>
<width>2490</width>
<height>367</height>
</rect>
</property>
Expand All @@ -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>
Expand Down
Loading