Project Configuration (cfg File)

From SysCAD Documentation
Jump to: navigation, search

Navigation: User Guide -> Project Configuration (cfg File)

Project Configuration
(Main Page)
Model Selection General Configuration Species Configuration Species Properties Configuration Calculation Configuration Size Configuration

Related Links: Species Table, Editing SysCAD Database, Size Configuration, Open Project with alternate configuration

This page is for SysCAD 9.3 Build 137 only. For earlier builds, please see Project Configuration (cfg File) 9.3


Introduction

The project.cfg (model configuration) file is edited by the user to customise each SysCAD project or project group. When the Edit | Project Configuration command is activated, the following pop up window will be loaded.

WARNING: This is only available when a SysCAD project is NOT loaded.

Select the solve mode (Steady State OR Dynamic), the available configuration file for the selected solve mode will be displayed below.The available configuration file for the selected solve mode will be displayed here. Right click on selected entries will bring up some pop up options.New will create a completely new configuration file and folder.Copy will create of copy of the currently highlighted configuration file.Remove will remove the currently highlighted configuration file from the list.Browse will allow you to browse for an existing configuration file.Allows the user to edit the Species Database associated with the highlighted configuration file.Allows the user to edit the Conversions Table.Allows the user to check if there are any errors in the highlighted configuration file.This will allow the user to edit the configuration file.Click on the done button to close the Project Configuration dialog.EditConfiguration137.png
About this image
Button Small 1.png Select Solve Mode.
Button Small 2.png Display a list of configuration for the selected solve mode. See also Right Click Pop up List
Button Small 3.png Creates a new configuration file
Button Small 4.png Copy an existing configuration to create a new file
Button Small 5.png Removes an existing configuration file from the list
Button Small 6.png Browse an existing configuration to the list
Button Small 7.png Edits an existing configuration file
Button Small 8.png Edits the user species database with reference to the selected configuration file
Button Small 9.png Edits the user conversion database
Button Small 10.png Tests the species database for known errors
Button Small 11.png Closes the dialog box.

Video Links

The following videos show different aspects of the Configuration file:

  • This tutorial video shows you how to create a new project group in SysCAD. (This basically copies an existing configuration folder and creates a new one.)
  • This tutorial video shows you how to add a species to the Configuration file. It also explains some of the Configuration functionality.

Location of Configuration Files

  1. SysCAD always expects projects to be located in the same folder as the configuration file that they are using. This is not strictly enforced, and the user may store the project and the configuration files in separate locations. (This is not recommended, as it can lead to confusion).
  2. The user may check which configuration file the project is using by accessing the View - Project command. Please see Project Window - Files List for details.

Creating a New Configuration File

To create a new configuration file, click on the NEW button (Button Small 3.png) in the configuration editor shown above. The following dialog boxes will become visible:

CreateNewCfg137.png
  1. Choose the Solve Mode (Steady State or Dynamic)
  2. Enter the required name of the configuration file.
  3. If the check box Project Set Same as Config Name is ticked, then the project folder will be the same as the Configuration file name. the Folder path is correct. This is the default option and reduces confusion with folder names.
  4. The Files Folder is the name of the folder in which the configuration file and the species database will be stored. By default this is called CfgFiles.
  5. You may enter a description for the project in the Description field.
  6. The default for the root folder will be within SysCAD Projects, but you may browse and change this to any path.
  7. Models to include - this will pre-select some model groups
  8. Click OK when finished.


EXAMPLE:

If you changed the config name to "SysCAD Training" in the above configuration file dialog box, then the following folders and files will be created:

  • A folder under SysCAD Projects called SysCAD Training, containing a sub-folder called CfgFiles.
  • Files called SysCAD.93.db3 and SysCAD Training.cfg will be created and stored in the CfgFiles sub-folder.
  • The species database will only contain steam, water and sulfuric acid at this stage.

Copying an Existing Configuration File

You may also use an existing configuration file as a template and save it as another file:

  1. Highlight the configuration file you would like to copy and press the COPY button Button Small 4.png).
    • A pop up list will appear with the two options (The first option will depend on the solve model selected Button Small 1.png):
    CopyCfg137.png
    • The first option allows the user to make a duplicate of the configuration file and set it to a different solver mode.
      • If a dynamic configuration file is created, "_Dyn" will be appended to the file name.
      • If a steady configuration file is created, "_SS" will be appended to the file name.
    • The second option allows the user to make a copy of the configuration file and rename the file manually.
  2. If the first option is selected, the file copy will be automatic.
  3. If the second option is selected, you will see a dialog box almost identical to the one presented in Creating a New Configuration File. The only difference will be instead of the words Create New Configuration at the top of the window, you will see Create Copy of xxxxx, where xxxx is the file path of the configuration file you are copying.
  4. Follow the instruction as per Creating a New Configuration File to complete the dialog box.

EXAMPLE: If you changed the config name to Gold Project in the above configuration file dialog box, then the following folders and files will be created:

  • A folder under SysCAD Projects called Gold Project, containing a sub-folder called CfgFiles.
  • Files called SysCAD.93.db3 and Gold Project.cfg will be created and stored in the CfgFiles sub-folder. The configuration file and the database will be identical to the configuration file and database in SysCAD Training, the original project. Therefore, they will contain all of the species that are available in SysCAD Training.

TUTORIAL:

Please also see a short video clip describing how to create a new Project Group - which is basically copying a Configuration file - Copy an existing Configuration for a new Project Group

Remove an Existing Configuration File

Highlight the configuration file(s) you would like to remove and press the Remove button Button Small 5.png).

Edit an Existing Configuration File

To edit the configuration file, select the file to be edited from the Project Configurations Dialog box, press Edit Button Small 7.png or double click with the left mouse button.

Editing the configuration file is a two step procedure:

Step 1:

Step 2: Set up the general project and species data:

Edit Species Database

To edit the User species database with reference to the selected configuration file, press Species DB button Button Small 8.png.

Edit Conversion Database

To edit the User conversion database with reference to the selected configuration file, press Cnvs DB button Button Small 9.png.


Right Click Pop up List

Select a single or multiple entries on the list Button Small 2.png then right click may bring up a the following pop up list:

PopupCfg137.png

If more than one entries were selected, the list will be divided into two sections:

  • the entry (closest to the right click) will be listed here, the options listed in this top section will apply to this entry only.
  • Remove Entry: removes the configuration file from this dialog box only
  • Remove Entry and Delete Configuration file: removes the configuration file from this dialog box and deletes it from the Cfgfiles folder.
  • Copy as Steady State / Dynamic Configuration: allows the user to make a duplicate of the configuration file and set it to a different solver mode.
  • Copy and Rename Configuration: allows the user to make a copy of the configuration file and rename the file manually.
  • Open Containing folder: Opens Windows Explorer and jumps to the folder containing the selected configuration file.

  • Remove Selected Entries: removes all the selected configuration files from this dialog box only
  • Remove Selected Entries and Delete Configuration files: removes all the configuration files from this dialog box and delete them from the Cfgfiles folder.